Liferay 6.0.5

com.liferay.portlet.announcements.model
Interface AnnouncementsDeliveryModel

All Superinterfaces:
BaseModel<AnnouncementsDelivery>, Cloneable, Comparable<AnnouncementsDelivery>, Serializable
All Known Subinterfaces:
AnnouncementsDelivery
All Known Implementing Classes:
AnnouncementsDeliveryImpl, AnnouncementsDeliveryModelImpl, AnnouncementsDeliveryWrapper

public interface AnnouncementsDeliveryModel
extends BaseModel<AnnouncementsDelivery>

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

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

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

See Also:
AnnouncementsDelivery, AnnouncementsDeliveryImpl, AnnouncementsDeliveryModelImpl
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(AnnouncementsDelivery announcementsDelivery)
           
 long getCompanyId()
          Gets the company id of this announcements delivery.
 long getDeliveryId()
          Gets the delivery id of this announcements delivery.
 boolean getEmail()
          Gets the email of this announcements delivery.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 long getPrimaryKey()
          Gets the primary key of this announcements delivery.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 boolean getSms()
          Gets the sms of this announcements delivery.
 String getType()
          Gets the type of this announcements delivery.
 long getUserId()
          Gets the user id of this announcements delivery.
 String getUserUuid()
          Gets the user uuid of this announcements delivery.
 boolean getWebsite()
          Gets the website of this announcements delivery.
 int hashCode()
           
 boolean isCachedModel()
          Determines if this model instance was retrieved from the entity cache.
 boolean isEmail()
          Determines whether this announcements delivery is email.
 boolean isEscapedModel()
          Determines if this model instance is escaped.
 boolean isNew()
          Determines if this model instance does not yet exist in the database.
 boolean isSms()
          Determines whether this announcements delivery is sms.
 boolean isWebsite()
          Determines whether this announcements delivery is website.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setCompanyId(long companyId)
          Sets the company id of this announcements delivery.
 void setDeliveryId(long deliveryId)
          Sets the delivery id of this announcements delivery.
 void setEmail(boolean email)
          Sets whether this {$entity.humanName} is email.
 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 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 delivery
 void setSms(boolean sms)
          Sets whether this {$entity.humanName} is sms.
 void setType(String type)
          Sets the type of this announcements delivery.
 void setUserId(long userId)
          Sets the user id of this announcements delivery.
 void setUserUuid(String userUuid)
          Sets the user uuid of this announcements delivery.
 void setWebsite(boolean website)
          Sets whether this {$entity.humanName} is website.
 AnnouncementsDelivery toEscapedModel()
          Gets a copy of this announcements delivery 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 delivery.

Returns:
the primary key of this announcements delivery

setPrimaryKey

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

Parameters:
pk - the primary key of this announcements delivery

getDeliveryId

long getDeliveryId()
Gets the delivery id of this announcements delivery.

Returns:
the delivery id of this announcements delivery

setDeliveryId

void setDeliveryId(long deliveryId)
Sets the delivery id of this announcements delivery.

Parameters:
deliveryId - the delivery id of this announcements delivery

getCompanyId

long getCompanyId()
Gets the company id of this announcements delivery.

Returns:
the company id of this announcements delivery

setCompanyId

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

Parameters:
companyId - the company id of this announcements delivery

getUserId

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

Returns:
the user id of this announcements delivery

setUserId

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

Parameters:
userId - the user id of this announcements delivery

getUserUuid

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

Returns:
the user uuid of this announcements delivery
Throws:
SystemException - if a system exception occurred

setUserUuid

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

Parameters:
userUuid - the user uuid of this announcements delivery

getType

@AutoEscape
String getType()
Gets the type of this announcements delivery.

Returns:
the type of this announcements delivery

setType

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

Parameters:
type - the type of this announcements delivery

getEmail

boolean getEmail()
Gets the email of this announcements delivery.

Returns:
the email of this announcements delivery

isEmail

boolean isEmail()
Determines whether this announcements delivery is email.

Returns:
whether this announcements delivery is email

setEmail

void setEmail(boolean email)
Sets whether this {$entity.humanName} is email.

Parameters:
email - the email of this announcements delivery

getSms

boolean getSms()
Gets the sms of this announcements delivery.

Returns:
the sms of this announcements delivery

isSms

boolean isSms()
Determines whether this announcements delivery is sms.

Returns:
whether this announcements delivery is sms

setSms

void setSms(boolean sms)
Sets whether this {$entity.humanName} is sms.

Parameters:
sms - the sms of this announcements delivery

getWebsite

boolean getWebsite()
Gets the website of this announcements delivery.

Returns:
the website of this announcements delivery

isWebsite

boolean isWebsite()
Determines whether this announcements delivery is website.

Returns:
whether this announcements delivery is website

setWebsite

void setWebsite(boolean website)
Sets whether this {$entity.humanName} is website.

Parameters:
website - the website of this announcements delivery

toEscapedModel

AnnouncementsDelivery toEscapedModel()
Gets a copy of this announcements delivery 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<AnnouncementsDelivery>
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<AnnouncementsDelivery>
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<AnnouncementsDelivery>
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<AnnouncementsDelivery>
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<AnnouncementsDelivery>
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<AnnouncementsDelivery>
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<AnnouncementsDelivery>
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<AnnouncementsDelivery>
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<AnnouncementsDelivery>
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<AnnouncementsDelivery>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(AnnouncementsDelivery announcementsDelivery)
Specified by:
compareTo in interface Comparable<AnnouncementsDelivery>

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<AnnouncementsDelivery>
Returns:
the XML representation of this model instance

Liferay 6.0.5