Liferay 6.1.2-ce-ga3

com.liferay.portlet.polls.model
Interface PollsChoiceModel

All Superinterfaces:
BaseModel<PollsChoice>, ClassedModel, Cloneable, Comparable<PollsChoice>, Serializable
All Known Subinterfaces:
PollsChoice
All Known Implementing Classes:
PollsChoiceWrapper

public interface PollsChoiceModel
extends BaseModel<PollsChoice>

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

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

See Also:
PollsChoice, PollsChoiceImpl, PollsChoiceModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(PollsChoice pollsChoice)
           
 long getChoiceId()
          Returns the choice ID of this polls choice.
 String getDescription()
          Returns the description of this polls choice.
 String getDescription(Locale locale)
          Returns the localized description of this polls choice in the language.
 String getDescription(Locale locale, boolean useDefault)
          Returns the localized description of this polls choice in the language, optionally using the default language if no localization exists for the requested language.
 String getDescription(String languageId)
          Returns the localized description of this polls choice in the language.
 String getDescription(String languageId, boolean useDefault)
          Returns the localized description of this polls choice in the language, optionally using the default language if no localization exists for the requested language.
 String getDescriptionCurrentLanguageId()
           
 String getDescriptionCurrentValue()
           
 Map<Locale,String> getDescriptionMap()
          Returns a map of the locales and localized descriptions of this polls choice.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 String getName()
          Returns the name of this polls choice.
 long getPrimaryKey()
          Returns the primary key of this polls choice.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getQuestionId()
          Returns the question ID of this polls choice.
 String getUuid()
          Returns the uuid of this polls choice.
 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 prepareLocalizedFieldsForImport(Locale defaultImportLocale)
           
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setChoiceId(long choiceId)
          Sets the choice ID of this polls choice.
 void setDescription(String description)
          Sets the description of this polls choice.
 void setDescription(String description, Locale locale)
          Sets the localized description of this polls choice in the language.
 void setDescription(String description, Locale locale, Locale defaultLocale)
          Sets the localized description of this polls choice in the language, and sets the default locale.
 void setDescriptionCurrentLanguageId(String languageId)
           
 void setDescriptionMap(Map<Locale,String> descriptionMap)
          Sets the localized descriptions of this polls choice from the map of locales and localized descriptions.
 void setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
          Sets the localized descriptions of this polls choice from the map of locales and localized descriptions, and sets the default locale.
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setName(String name)
          Sets the name of this polls choice.
 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 choice.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setQuestionId(long questionId)
          Sets the question ID of this polls choice.
 void setUuid(String uuid)
          Sets the uuid of this polls choice.
 CacheModel<PollsChoice> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 PollsChoice toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 PollsChoice 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 polls choice.

Returns:
the primary key of this polls choice

setPrimaryKey

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

Parameters:
primaryKey - the primary key of this polls choice

getUuid

@AutoEscape
String getUuid()
Returns the uuid of this polls choice.

Returns:
the uuid of this polls choice

setUuid

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

Parameters:
uuid - the uuid of this polls choice

getChoiceId

long getChoiceId()
Returns the choice ID of this polls choice.

Returns:
the choice ID of this polls choice

setChoiceId

void setChoiceId(long choiceId)
Sets the choice ID of this polls choice.

Parameters:
choiceId - the choice ID of this polls choice

getQuestionId

long getQuestionId()
Returns the question ID of this polls choice.

Returns:
the question ID of this polls choice

setQuestionId

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

Parameters:
questionId - the question ID of this polls choice

getName

@AutoEscape
String getName()
Returns the name of this polls choice.

Returns:
the name of this polls choice

setName

void setName(String name)
Sets the name of this polls choice.

Parameters:
name - the name of this polls choice

getDescription

String getDescription()
Returns the description of this polls choice.

Returns:
the description of this polls choice

getDescription

@AutoEscape
String getDescription(Locale locale)
Returns the localized description of this polls choice in the language. Uses the default language if no localization exists for the requested language.

Parameters:
locale - the locale of the language
Returns:
the localized description of this polls choice

getDescription

@AutoEscape
String getDescription(Locale locale,
                                 boolean useDefault)
Returns the localized description of this polls choice in the language, optionally using the default language if no localization exists for the requested language.

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

getDescription

@AutoEscape
String getDescription(String languageId)
Returns the localized description of this polls choice in the language. Uses the default language if no localization exists for the requested language.

Parameters:
languageId - the ID of the language
Returns:
the localized description of this polls choice

getDescription

@AutoEscape
String getDescription(String languageId,
                                 boolean useDefault)
Returns the localized description of this polls choice in the language, optionally using the default language if no localization exists for the requested language.

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

getDescriptionCurrentLanguageId

@AutoEscape
String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue

@AutoEscape
String getDescriptionCurrentValue()

getDescriptionMap

Map<Locale,String> getDescriptionMap()
Returns a map of the locales and localized descriptions of this polls choice.

Returns:
the locales and localized descriptions of this polls choice

setDescription

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

Parameters:
description - the description of this polls choice

setDescription

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

Parameters:
description - the localized description of this polls choice
locale - the locale of the language

setDescription

void setDescription(String description,
                    Locale locale,
                    Locale defaultLocale)
Sets the localized description of this polls choice in the language, and sets the default locale.

Parameters:
description - the localized description of this polls choice
locale - the locale of the language
defaultLocale - the default locale

setDescriptionCurrentLanguageId

void setDescriptionCurrentLanguageId(String languageId)

setDescriptionMap

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

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

setDescriptionMap

void setDescriptionMap(Map<Locale,String> descriptionMap,
                       Locale defaultLocale)
Sets the localized descriptions of this polls choice from the map of locales and localized descriptions, and sets the default locale.

Parameters:
descriptionMap - the locales and localized descriptions of this polls choice
defaultLocale - the default locale

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<PollsChoice>
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<PollsChoice>
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<PollsChoice>
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<PollsChoice>
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<PollsChoice>
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<PollsChoice>
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<PollsChoice>
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<PollsChoice>
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<PollsChoice>
Parameters:
serviceContext - the service context
See Also:
ServiceContext.getExpandoBridgeAttributes( )

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                                     throws LocaleException
Throws:
LocaleException

clone

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

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

compareTo

int compareTo(PollsChoice pollsChoice)
Specified by:
compareTo in interface Comparable<PollsChoice>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

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

toUnescapedModel

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

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

Liferay 6.1.2-ce-ga3