Liferay 6.1.2-ce-ga3

com.liferay.portlet.announcements.model
Interface AnnouncementsEntryModel

All Superinterfaces:
AttachedModel, AuditedModel, BaseModel<AnnouncementsEntry>, ClassedModel, Cloneable, Comparable<AnnouncementsEntry>, Serializable
All Known Subinterfaces:
AnnouncementsEntry
All Known Implementing Classes:
AnnouncementsEntryBaseImpl, AnnouncementsEntryImpl, AnnouncementsEntryModelImpl, AnnouncementsEntryWrapper

public interface AnnouncementsEntryModel
extends AttachedModel, AuditedModel, BaseModel<AnnouncementsEntry>

The base model interface for the AnnouncementsEntry service. Represents a row in the "AnnouncementsEntry" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation AnnouncementsEntryModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in AnnouncementsEntryImpl.

See Also:
AnnouncementsEntry, AnnouncementsEntryImpl, AnnouncementsEntryModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(AnnouncementsEntry announcementsEntry)
           
 boolean getAlert()
          Returns the alert of this announcements entry.
 String getClassName()
          Returns the fully qualified class name of this announcements entry.
 long getClassNameId()
          Returns the class name ID of this announcements entry.
 long getClassPK()
          Returns the class p k of this announcements entry.
 long getCompanyId()
          Returns the company ID of this announcements entry.
 String getContent()
          Returns the content of this announcements entry.
 Date getCreateDate()
          Returns the create date of this announcements entry.
 Date getDisplayDate()
          Returns the display date of this announcements entry.
 long getEntryId()
          Returns the entry ID of this announcements entry.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 Date getExpirationDate()
          Returns the expiration date of this announcements entry.
 Date getModifiedDate()
          Returns the modified date of this announcements entry.
 long getPrimaryKey()
          Returns the primary key of this announcements entry.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 int getPriority()
          Returns the priority of this announcements entry.
 String getTitle()
          Returns the title of this announcements entry.
 String getType()
          Returns the type of this announcements entry.
 String getUrl()
          Returns the url of this announcements entry.
 long getUserId()
          Returns the user ID of this announcements entry.
 String getUserName()
          Returns the user name of this announcements entry.
 String getUserUuid()
          Returns the user uuid of this announcements entry.
 String getUuid()
          Returns the uuid of this announcements entry.
 int hashCode()
           
 boolean isAlert()
          Returns true if this announcements entry is alert.
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 void setAlert(boolean alert)
          Sets whether this announcements entry is alert.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setClassName(String className)
           
 void setClassNameId(long classNameId)
          Sets the class name ID of this announcements entry.
 void setClassPK(long classPK)
          Sets the class p k of this announcements entry.
 void setCompanyId(long companyId)
          Sets the company ID of this announcements entry.
 void setContent(String content)
          Sets the content of this announcements entry.
 void setCreateDate(Date createDate)
          Sets the create date of this announcements entry.
 void setDisplayDate(Date displayDate)
          Sets the display date of this announcements entry.
 void setEntryId(long entryId)
          Sets the entry ID of this announcements entry.
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setExpirationDate(Date expirationDate)
          Sets the expiration date of this announcements entry.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this announcements entry.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this announcements entry.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setPriority(int priority)
          Sets the priority of this announcements entry.
 void setTitle(String title)
          Sets the title of this announcements entry.
 void setType(String type)
          Sets the type of this announcements entry.
 void setUrl(String url)
          Sets the url of this announcements entry.
 void setUserId(long userId)
          Sets the user ID of this announcements entry.
 void setUserName(String userName)
          Sets the user name of this announcements entry.
 void setUserUuid(String userUuid)
          Sets the user uuid of this announcements entry.
 void setUuid(String uuid)
          Sets the uuid of this announcements entry.
 CacheModel<AnnouncementsEntry> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 AnnouncementsEntry toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 AnnouncementsEntry toUnescapedModel()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Returns the primary key of this announcements entry.

Returns:
the primary key of this announcements entry

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this announcements entry.

Parameters:
primaryKey - the primary key of this announcements entry

getUuid

@AutoEscape
String getUuid()
Returns the uuid of this announcements entry.

Returns:
the uuid of this announcements entry

setUuid

void setUuid(String uuid)
Sets the uuid of this announcements entry.

Parameters:
uuid - the uuid of this announcements entry

getEntryId

long getEntryId()
Returns the entry ID of this announcements entry.

Returns:
the entry ID of this announcements entry

setEntryId

void setEntryId(long entryId)
Sets the entry ID of this announcements entry.

Parameters:
entryId - the entry ID of this announcements entry

getCompanyId

long getCompanyId()
Returns the company ID of this announcements entry.

Specified by:
getCompanyId in interface AuditedModel
Returns:
the company ID of this announcements entry

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this announcements entry.

Specified by:
setCompanyId in interface AuditedModel
Parameters:
companyId - the company ID of this announcements entry

getUserId

long getUserId()
Returns the user ID of this announcements entry.

Specified by:
getUserId in interface AuditedModel
Returns:
the user ID of this announcements entry

setUserId

void setUserId(long userId)
Sets the user ID of this announcements entry.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this announcements entry

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this announcements entry.

Specified by:
getUserUuid in interface AuditedModel
Returns:
the user uuid of this announcements entry
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this announcements entry.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this announcements entry

getUserName

@AutoEscape
String getUserName()
Returns the user name of this announcements entry.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this announcements entry

setUserName

void setUserName(String userName)
Sets the user name of this announcements entry.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this announcements entry

getCreateDate

Date getCreateDate()
Returns the create date of this announcements entry.

Specified by:
getCreateDate in interface AuditedModel
Returns:
the create date of this announcements entry

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this announcements entry.

Specified by:
setCreateDate in interface AuditedModel
Parameters:
createDate - the create date of this announcements entry

getModifiedDate

Date getModifiedDate()
Returns the modified date of this announcements entry.

Specified by:
getModifiedDate in interface AuditedModel
Returns:
the modified date of this announcements entry

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this announcements entry.

Specified by:
setModifiedDate in interface AuditedModel
Parameters:
modifiedDate - the modified date of this announcements entry

getClassName

String getClassName()
Returns the fully qualified class name of this announcements entry.

Specified by:
getClassName in interface AttachedModel
Returns:
the fully qualified class name of this announcements entry

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()
Returns the class name ID of this announcements entry.

Specified by:
getClassNameId in interface AttachedModel
Returns:
the class name ID of this announcements entry

setClassNameId

void setClassNameId(long classNameId)
Sets the class name ID of this announcements entry.

Specified by:
setClassNameId in interface AttachedModel
Parameters:
classNameId - the class name ID of this announcements entry

getClassPK

long getClassPK()
Returns the class p k of this announcements entry.

Specified by:
getClassPK in interface AttachedModel
Returns:
the class p k of this announcements entry

setClassPK

void setClassPK(long classPK)
Sets the class p k of this announcements entry.

Specified by:
setClassPK in interface AttachedModel
Parameters:
classPK - the class p k of this announcements entry

getTitle

@AutoEscape
String getTitle()
Returns the title of this announcements entry.

Returns:
the title of this announcements entry

setTitle

void setTitle(String title)
Sets the title of this announcements entry.

Parameters:
title - the title of this announcements entry

getContent

@AutoEscape
String getContent()
Returns the content of this announcements entry.

Returns:
the content of this announcements entry

setContent

void setContent(String content)
Sets the content of this announcements entry.

Parameters:
content - the content of this announcements entry

getUrl

@AutoEscape
String getUrl()
Returns the url of this announcements entry.

Returns:
the url of this announcements entry

setUrl

void setUrl(String url)
Sets the url of this announcements entry.

Parameters:
url - the url of this announcements entry

getType

@AutoEscape
String getType()
Returns the type of this announcements entry.

Returns:
the type of this announcements entry

setType

void setType(String type)
Sets the type of this announcements entry.

Parameters:
type - the type of this announcements entry

getDisplayDate

Date getDisplayDate()
Returns the display date of this announcements entry.

Returns:
the display date of this announcements entry

setDisplayDate

void setDisplayDate(Date displayDate)
Sets the display date of this announcements entry.

Parameters:
displayDate - the display date of this announcements entry

getExpirationDate

Date getExpirationDate()
Returns the expiration date of this announcements entry.

Returns:
the expiration date of this announcements entry

setExpirationDate

void setExpirationDate(Date expirationDate)
Sets the expiration date of this announcements entry.

Parameters:
expirationDate - the expiration date of this announcements entry

getPriority

int getPriority()
Returns the priority of this announcements entry.

Returns:
the priority of this announcements entry

setPriority

void setPriority(int priority)
Sets the priority of this announcements entry.

Parameters:
priority - the priority of this announcements entry

getAlert

boolean getAlert()
Returns the alert of this announcements entry.

Returns:
the alert of this announcements entry

isAlert

boolean isAlert()
Returns true if this announcements entry is alert.

Returns:
true if this announcements entry is alert; false otherwise

setAlert

void setAlert(boolean alert)
Sets whether this announcements entry is alert.

Parameters:
alert - the alert of this announcements entry

isNew

boolean isNew()
Description copied from interface: BaseModel
Returns true if this model instance does not yet exist in the database.

Specified by:
isNew in interface BaseModel<AnnouncementsEntry>
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

void setNew(boolean n)
Description copied from interface: BaseModel
Sets whether this model instance does not yet exist in the database.

Specified by:
setNew in interface BaseModel<AnnouncementsEntry>
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

boolean isCachedModel()
Description copied from interface: BaseModel
Returns true if this model instance was retrieved from the entity cache.

Specified by:
isCachedModel in interface BaseModel<AnnouncementsEntry>
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

setCachedModel

void setCachedModel(boolean cachedModel)
Description copied from interface: BaseModel
Sets whether this model instance was retrieved from the entity cache.

Specified by:
setCachedModel in interface BaseModel<AnnouncementsEntry>
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

boolean isEscapedModel()
Description copied from interface: BaseModel
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<AnnouncementsEntry>
Returns:
true if this model instance is escaped; false otherwise

getPrimaryKeyObj

Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Returns the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<AnnouncementsEntry>
Specified by:
getPrimaryKeyObj in interface ClassedModel
Returns:
the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)
Description copied from interface: BaseModel
Sets the primary key of this model instance.

Specified by:
setPrimaryKeyObj in interface BaseModel<AnnouncementsEntry>
Specified by:
setPrimaryKeyObj in interface ClassedModel
Parameters:
primaryKeyObj - the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Returns the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<AnnouncementsEntry>
Specified by:
getExpandoBridge in interface ClassedModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ServiceContext serviceContext)
Description copied from interface: BaseModel
Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:
setExpandoBridgeAttributes in interface BaseModel<AnnouncementsEntry>
Parameters:
serviceContext - the service context
See Also:
ServiceContext.getExpandoBridgeAttributes( )

clone

Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<AnnouncementsEntry>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(AnnouncementsEntry announcementsEntry)
Specified by:
compareTo in interface Comparable<AnnouncementsEntry>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

CacheModel<AnnouncementsEntry> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<AnnouncementsEntry>
Returns:
the cache model object

toEscapedModel

AnnouncementsEntry toEscapedModel()
Description copied from interface: BaseModel
Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface BaseModel<AnnouncementsEntry>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

AnnouncementsEntry toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<AnnouncementsEntry>

toString

String toString()
Overrides:
toString in class Object

toXmlString

String toXmlString()
Description copied from interface: BaseModel
Returns the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<AnnouncementsEntry>
Returns:
the XML representation of this model instance

Liferay 6.1.2-ce-ga3