Liferay 6.0.5

com.liferay.portlet.announcements.model
Interface AnnouncementsEntryModel

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

public interface AnnouncementsEntryModel
extends 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.

Never modify or reference this interface directly. All methods that expect a announcements entry model instance should use the AnnouncementsEntry interface instead.

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

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(AnnouncementsEntry announcementsEntry)
           
 boolean getAlert()
          Gets the alert of this announcements entry.
 String getClassName()
          Gets the class name of the model instance this announcements entry is polymorphically associated with.
 long getClassNameId()
          Gets the class name id of this announcements entry.
 long getClassPK()
          Gets the class p k of this announcements entry.
 long getCompanyId()
          Gets the company id of this announcements entry.
 String getContent()
          Gets the content of this announcements entry.
 Date getCreateDate()
          Gets the create date of this announcements entry.
 Date getDisplayDate()
          Gets the display date of this announcements entry.
 long getEntryId()
          Gets the entry id of this announcements entry.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 Date getExpirationDate()
          Gets the expiration date of this announcements entry.
 Date getModifiedDate()
          Gets the modified date of this announcements entry.
 long getPrimaryKey()
          Gets the primary key of this announcements entry.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 int getPriority()
          Gets the priority of this announcements entry.
 String getTitle()
          Gets the title of this announcements entry.
 String getType()
          Gets the type of this announcements entry.
 String getUrl()
          Gets the url of this announcements entry.
 long getUserId()
          Gets the user id of this announcements entry.
 String getUserName()
          Gets the user name of this announcements entry.
 String getUserUuid()
          Gets the user uuid of this announcements entry.
 String getUuid()
          Gets the uuid of this announcements entry.
 int hashCode()
           
 boolean isAlert()
          Determines whether this announcements entry is alert.
 boolean isCachedModel()
          Determines if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Determines if this model instance is escaped.
 boolean isNew()
          Determines if this model instance does not yet exist in the database.
 void setAlert(boolean alert)
          Sets whether this {$entity.humanName} is alert.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 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 setEscapedModel(boolean escapedModel)
          Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
 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 pk)
          Sets the primary key of this announcements entry
 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.
 AnnouncementsEntry toEscapedModel()
          Gets a copy of this announcements entry as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 

Method Detail

getPrimaryKey

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

Returns:
the primary key of this announcements entry

setPrimaryKey

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

Parameters:
pk - the primary key of this announcements entry

getUuid

@AutoEscape
String getUuid()
Gets 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()
Gets 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()
Gets the company id of this announcements entry.

Returns:
the company id of this announcements entry

setCompanyId

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

Parameters:
companyId - the company id of this announcements entry

getUserId

long getUserId()
Gets the user id of this announcements entry.

Returns:
the user id of this announcements entry

setUserId

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

Parameters:
userId - the user id of this announcements entry

getUserUuid

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

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.

Parameters:
userUuid - the user uuid of this announcements entry

getUserName

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

Returns:
the user name of this announcements entry

setUserName

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

Parameters:
userName - the user name of this announcements entry

getCreateDate

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

Returns:
the create date of this announcements entry

setCreateDate

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

Parameters:
createDate - the create date of this announcements entry

getModifiedDate

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

Returns:
the modified date of this announcements entry

setModifiedDate

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

Parameters:
modifiedDate - the modified date of this announcements entry

getClassName

String getClassName()
Gets the class name of the model instance this announcements entry is polymorphically associated with.

Returns:
the class name of the model instance this announcements entry is polymorphically associated with

getClassNameId

long getClassNameId()
Gets the class name id of this announcements entry.

Returns:
the class name id of this announcements entry

setClassNameId

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

Parameters:
classNameId - the class name id of this announcements entry

getClassPK

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

Returns:
the class p k of this announcements entry

setClassPK

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

Parameters:
classPK - the class p k of this announcements entry

getTitle

@AutoEscape
String getTitle()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets the alert of this announcements entry.

Returns:
the alert of this announcements entry

isAlert

boolean isAlert()
Determines whether this announcements entry is alert.

Returns:
whether this announcements entry is alert

setAlert

void setAlert(boolean alert)
Sets whether this {$entity.humanName} is alert.

Parameters:
alert - the alert of this announcements entry

toEscapedModel

AnnouncementsEntry toEscapedModel()
Gets a copy of this announcements entry as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

isNew

boolean isNew()
Description copied from interface: BaseModel
Determines 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
Determines 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
Determines if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<AnnouncementsEntry>
Returns:
true if this model instance is escaped; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)
Description copied from interface: BaseModel
Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:
setEscapedModel in interface BaseModel<AnnouncementsEntry>
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

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

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

getExpandoBridge

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

Specified by:
getExpandoBridge in interface BaseModel<AnnouncementsEntry>
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 to retrieve the expando bridge attributes from
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

toString

String toString()
Overrides:
toString in class Object

toXmlString

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

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

Liferay 6.0.5