Liferay 6.0-ee-sp2

com.liferay.portlet.polls.model
Interface PollsQuestionModel

All Superinterfaces:
AuditedModel, BaseModel<PollsQuestion>, ClassedModel, Cloneable, Comparable<PollsQuestion>, GroupedModel, Serializable
All Known Subinterfaces:
PollsQuestion
All Known Implementing Classes:
PollsQuestionWrapper

public interface PollsQuestionModel
extends BaseModel<PollsQuestion>, GroupedModel

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

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

See Also:
PollsQuestion, PollsQuestionImpl, PollsQuestionModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(PollsQuestion pollsQuestion)
           
 long getCompanyId()
          Gets the company ID of this polls question.
 Date getCreateDate()
          Gets the create date of this polls question.
 String getDescription()
          Gets the description of this polls question.
 String getDescription(Locale locale)
          Gets the localized description of this polls question.
 String getDescription(Locale locale, boolean useDefault)
          Gets the localized description of this polls question, optionally using the default language if no localization exists for the requested language.
 String getDescription(String languageId)
          Gets the localized description of this polls question.
 String getDescription(String languageId, boolean useDefault)
          Gets the localized description of this polls question, optionally using the default language if no localization exists for the requested language.
 Map<Locale,String> getDescriptionMap()
          Gets a map of the locales and localized description of this polls question.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 Date getExpirationDate()
          Gets the expiration date of this polls question.
 long getGroupId()
          Gets the group ID of this polls question.
 Date getLastVoteDate()
          Gets the last vote date of this polls question.
 Date getModifiedDate()
          Gets the modified date of this polls question.
 long getPrimaryKey()
          Gets the primary key of this polls question.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getQuestionId()
          Gets the question ID of this polls question.
 String getTitle()
          Gets the title of this polls question.
 String getTitle(Locale locale)
          Gets the localized title of this polls question.
 String getTitle(Locale locale, boolean useDefault)
          Gets the localized title of this polls question, optionally using the default language if no localization exists for the requested language.
 String getTitle(String languageId)
          Gets the localized title of this polls question.
 String getTitle(String languageId, boolean useDefault)
          Gets the localized title of this polls question, optionally using the default language if no localization exists for the requested language.
 Map<Locale,String> getTitleMap()
          Gets a map of the locales and localized title of this polls question.
 long getUserId()
          Gets the user ID of this polls question.
 String getUserName()
          Gets the user name of this polls question.
 String getUserUuid()
          Gets the user uuid of this polls question.
 String getUuid()
          Gets the uuid of this polls question.
 int hashCode()
           
 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 setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setCompanyId(long companyId)
          Sets the company ID of this polls question.
 void setCreateDate(Date createDate)
          Sets the create date of this polls question.
 void setDescription(Locale locale, String description)
          Sets the localized description of this polls question.
 void setDescription(String description)
          Sets the description of this polls question.
 void setDescriptionMap(Map<Locale,String> descriptionMap)
          Sets the localized descriptions of this polls question from the map of locales and localized descriptions.
 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 polls question.
 void setGroupId(long groupId)
          Sets the group ID of this polls question.
 void setLastVoteDate(Date lastVoteDate)
          Sets the last vote date of this polls question.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this polls question.
 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 polls question
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setQuestionId(long questionId)
          Sets the question ID of this polls question.
 void setTitle(Locale locale, String title)
          Sets the localized title of this polls question.
 void setTitle(String title)
          Sets the title of this polls question.
 void setTitleMap(Map<Locale,String> titleMap)
          Sets the localized titles of this polls question from the map of locales and localized titles.
 void setUserId(long userId)
          Sets the user ID of this polls question.
 void setUserName(String userName)
          Sets the user name of this polls question.
 void setUserUuid(String userUuid)
          Sets the user uuid of this polls question.
 void setUuid(String uuid)
          Sets the uuid of this polls question.
 CacheModel<PollsQuestion> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 PollsQuestion toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
resetOriginalValues
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Gets the primary key of this polls question.

Returns:
the primary key of this polls question

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this polls question

Parameters:
primaryKey - the primary key of this polls question

getUuid

@AutoEscape
String getUuid()
Gets the uuid of this polls question.

Returns:
the uuid of this polls question

setUuid

void setUuid(String uuid)
Sets the uuid of this polls question.

Parameters:
uuid - the uuid of this polls question

getQuestionId

long getQuestionId()
Gets the question ID of this polls question.

Returns:
the question ID of this polls question

setQuestionId

void setQuestionId(long questionId)
Sets the question ID of this polls question.

Parameters:
questionId - the question ID of this polls question

getGroupId

long getGroupId()
Gets the group ID of this polls question.

Specified by:
getGroupId in interface GroupedModel
Returns:
the group ID of this polls question

setGroupId

void setGroupId(long groupId)
Sets the group ID of this polls question.

Specified by:
setGroupId in interface GroupedModel
Parameters:
groupId - the group ID of this polls question

getCompanyId

long getCompanyId()
Gets the company ID of this polls question.

Specified by:
getCompanyId in interface AuditedModel
Returns:
the company ID of this polls question

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this polls question.

Specified by:
setCompanyId in interface AuditedModel
Parameters:
companyId - the company ID of this polls question

getUserId

long getUserId()
Gets the user ID of this polls question.

Specified by:
getUserId in interface AuditedModel
Returns:
the user ID of this polls question

setUserId

void setUserId(long userId)
Sets the user ID of this polls question.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this polls question

getUserUuid

String getUserUuid()
                   throws SystemException
Gets the user uuid of this polls question.

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

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this polls question.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this polls question

getUserName

@AutoEscape
String getUserName()
Gets the user name of this polls question.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this polls question

setUserName

void setUserName(String userName)
Sets the user name of this polls question.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this polls question

getCreateDate

Date getCreateDate()
Gets the create date of this polls question.

Specified by:
getCreateDate in interface AuditedModel
Returns:
the create date of this polls question

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this polls question.

Specified by:
setCreateDate in interface AuditedModel
Parameters:
createDate - the create date of this polls question

getModifiedDate

Date getModifiedDate()
Gets the modified date of this polls question.

Specified by:
getModifiedDate in interface AuditedModel
Returns:
the modified date of this polls question

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this polls question.

Specified by:
setModifiedDate in interface AuditedModel
Parameters:
modifiedDate - the modified date of this polls question

getTitle

String getTitle()
Gets the title of this polls question.

Returns:
the title of this polls question

getTitle

String getTitle(Locale locale)
Gets the localized title of this polls question. Uses the default language if no localization exists for the requested language.

Parameters:
locale - the locale to get the localized title for
Returns:
the localized title of this polls question

getTitle

String getTitle(Locale locale,
                boolean useDefault)
Gets the localized title of this polls question, optionally using the default language if no localization exists for the requested language.

Parameters:
locale - the local to get the localized title for
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized title of this polls question. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getTitle

String getTitle(String languageId)
Gets the localized title of this polls question. Uses the default language if no localization exists for the requested language.

Parameters:
languageId - the id of the language to get the localized title for
Returns:
the localized title of this polls question

getTitle

String getTitle(String languageId,
                boolean useDefault)
Gets the localized title of this polls question, optionally using the default language if no localization exists for the requested language.

Parameters:
languageId - the id of the language to get the localized title for
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized title of this polls question

getTitleMap

Map<Locale,String> getTitleMap()
Gets a map of the locales and localized title of this polls question.

Returns:
the locales and localized title

setTitle

void setTitle(String title)
Sets the title of this polls question.

Parameters:
title - the title of this polls question

setTitle

void setTitle(Locale locale,
              String title)
Sets the localized title of this polls question.

Parameters:
locale - the locale to set the localized title for
title - the localized title of this polls question

setTitleMap

void setTitleMap(Map<Locale,String> titleMap)
Sets the localized titles of this polls question from the map of locales and localized titles.

Parameters:
titleMap - the locales and localized titles of this polls question

getDescription

String getDescription()
Gets the description of this polls question.

Returns:
the description of this polls question

getDescription

String getDescription(Locale locale)
Gets the localized description of this polls question. Uses the default language if no localization exists for the requested language.

Parameters:
locale - the locale to get the localized description for
Returns:
the localized description of this polls question

getDescription

String getDescription(Locale locale,
                      boolean useDefault)
Gets the localized description of this polls question, optionally using the default language if no localization exists for the requested language.

Parameters:
locale - the local to get the localized description for
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized description of this polls question. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getDescription

String getDescription(String languageId)
Gets the localized description of this polls question. Uses the default language if no localization exists for the requested language.

Parameters:
languageId - the id of the language to get the localized description for
Returns:
the localized description of this polls question

getDescription

String getDescription(String languageId,
                      boolean useDefault)
Gets the localized description of this polls question, optionally using the default language if no localization exists for the requested language.

Parameters:
languageId - the id of the language to get the localized description for
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized description of this polls question

getDescriptionMap

Map<Locale,String> getDescriptionMap()
Gets a map of the locales and localized description of this polls question.

Returns:
the locales and localized description

setDescription

void setDescription(String description)
Sets the description of this polls question.

Parameters:
description - the description of this polls question

setDescription

void setDescription(Locale locale,
                    String description)
Sets the localized description of this polls question.

Parameters:
locale - the locale to set the localized description for
description - the localized description of this polls question

setDescriptionMap

void setDescriptionMap(Map<Locale,String> descriptionMap)
Sets the localized descriptions of this polls question from the map of locales and localized descriptions.

Parameters:
descriptionMap - the locales and localized descriptions of this polls question

getExpirationDate

Date getExpirationDate()
Gets the expiration date of this polls question.

Returns:
the expiration date of this polls question

setExpirationDate

void setExpirationDate(Date expirationDate)
Sets the expiration date of this polls question.

Parameters:
expirationDate - the expiration date of this polls question

getLastVoteDate

Date getLastVoteDate()
Gets the last vote date of this polls question.

Returns:
the last vote date of this polls question

setLastVoteDate

void setLastVoteDate(Date lastVoteDate)
Sets the last vote date of this polls question.

Parameters:
lastVoteDate - the last vote date of this polls question

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<PollsQuestion>
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<PollsQuestion>
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<PollsQuestion>
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<PollsQuestion>
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<PollsQuestion>
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<PollsQuestion>
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

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

Specified by:
getPrimaryKeyObj in interface BaseModel<PollsQuestion>
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<PollsQuestion>
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<PollsQuestion>
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<PollsQuestion>
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<PollsQuestion>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(PollsQuestion pollsQuestion)
Specified by:
compareTo in interface Comparable<PollsQuestion>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

PollsQuestion 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<PollsQuestion>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

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

Liferay 6.0-ee-sp2