Liferay 6.1.2-ce-ga3

com.liferay.portlet.polls.model
Class PollsChoiceWrapper

java.lang.Object
  extended by com.liferay.portlet.polls.model.PollsChoiceWrapper
All Implemented Interfaces:
BaseModel<PollsChoice>, ClassedModel, ModelWrapper<PollsChoice>, PersistedModel, PollsChoice, PollsChoiceModel, Serializable, Cloneable, Comparable<PollsChoice>

public class PollsChoiceWrapper
extends Object
implements PollsChoice, ModelWrapper<PollsChoice>

This class is a wrapper for PollsChoice.

See Also:
PollsChoice, Serialized Form

Constructor Summary
PollsChoiceWrapper(PollsChoice pollsChoice)
           
 
Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(PollsChoice pollsChoice)
           
 boolean equals(Object obj)
           
 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.
 Map<String,Object> getModelAttributes()
           
 Class<?> getModelClass()
           
 String getModelClassName()
           
 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 getVotesCount()
           
 PollsChoice getWrappedModel()
           
 PollsChoice getWrappedPollsChoice()
          Deprecated. Renamed to getWrappedModel()
 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 persist()
          Updates this model instance in the database or adds it if it does not yet exist.
 void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
           
 void resetOriginalValues()
          Reset all original fields to current values.
 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 setModelAttributes(Map<String,Object> attributes)
           
 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 class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PollsChoiceWrapper

public PollsChoiceWrapper(PollsChoice pollsChoice)
Method Detail

getModelClass

public Class<?> getModelClass()
Specified by:
getModelClass in interface ClassedModel

getModelClassName

public String getModelClassName()
Specified by:
getModelClassName in interface ClassedModel

getModelAttributes

public Map<String,Object> getModelAttributes()
Specified by:
getModelAttributes in interface BaseModel<PollsChoice>

setModelAttributes

public void setModelAttributes(Map<String,Object> attributes)
Specified by:
setModelAttributes in interface BaseModel<PollsChoice>

getPrimaryKey

public long getPrimaryKey()
Returns the primary key of this polls choice.

Specified by:
getPrimaryKey in interface PollsChoiceModel
Returns:
the primary key of this polls choice

setPrimaryKey

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

Specified by:
setPrimaryKey in interface PollsChoiceModel
Parameters:
primaryKey - the primary key of this polls choice

getUuid

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

Specified by:
getUuid in interface PollsChoiceModel
Returns:
the uuid of this polls choice

setUuid

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

Specified by:
setUuid in interface PollsChoiceModel
Parameters:
uuid - the uuid of this polls choice

getChoiceId

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

Specified by:
getChoiceId in interface PollsChoiceModel
Returns:
the choice ID of this polls choice

setChoiceId

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

Specified by:
setChoiceId in interface PollsChoiceModel
Parameters:
choiceId - the choice ID of this polls choice

getQuestionId

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

Specified by:
getQuestionId in interface PollsChoiceModel
Returns:
the question ID of this polls choice

setQuestionId

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

Specified by:
setQuestionId in interface PollsChoiceModel
Parameters:
questionId - the question ID of this polls choice

getName

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

Specified by:
getName in interface PollsChoiceModel
Returns:
the name of this polls choice

setName

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

Specified by:
setName in interface PollsChoiceModel
Parameters:
name - the name of this polls choice

getDescription

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

Specified by:
getDescription in interface PollsChoiceModel
Returns:
the description of this polls choice

getDescription

public 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.

Specified by:
getDescription in interface PollsChoiceModel
Parameters:
locale - the locale of the language
Returns:
the localized description of this polls choice

getDescription

public 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.

Specified by:
getDescription in interface PollsChoiceModel
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

public 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.

Specified by:
getDescription in interface PollsChoiceModel
Parameters:
languageId - the ID of the language
Returns:
the localized description of this polls choice

getDescription

public 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.

Specified by:
getDescription in interface PollsChoiceModel
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

public String getDescriptionCurrentLanguageId()
Specified by:
getDescriptionCurrentLanguageId in interface PollsChoiceModel

getDescriptionCurrentValue

public String getDescriptionCurrentValue()
Specified by:
getDescriptionCurrentValue in interface PollsChoiceModel

getDescriptionMap

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

Specified by:
getDescriptionMap in interface PollsChoiceModel
Returns:
the locales and localized descriptions of this polls choice

setDescription

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

Specified by:
setDescription in interface PollsChoiceModel
Parameters:
description - the description of this polls choice

setDescription

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

Specified by:
setDescription in interface PollsChoiceModel
Parameters:
description - the localized description of this polls choice
locale - the locale of the language

setDescription

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

Specified by:
setDescription in interface PollsChoiceModel
Parameters:
description - the localized description of this polls choice
locale - the locale of the language
defaultLocale - the default locale

setDescriptionCurrentLanguageId

public void setDescriptionCurrentLanguageId(String languageId)
Specified by:
setDescriptionCurrentLanguageId in interface PollsChoiceModel

setDescriptionMap

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

Specified by:
setDescriptionMap in interface PollsChoiceModel
Parameters:
descriptionMap - the locales and localized descriptions of this polls choice

setDescriptionMap

public 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.

Specified by:
setDescriptionMap in interface PollsChoiceModel
Parameters:
descriptionMap - the locales and localized descriptions of this polls choice
defaultLocale - the default locale

isNew

public 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>
Specified by:
isNew in interface PollsChoiceModel
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

public 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>
Specified by:
setNew in interface PollsChoiceModel
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

public 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>
Specified by:
isCachedModel in interface PollsChoiceModel
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

setCachedModel

public 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>
Specified by:
setCachedModel in interface PollsChoiceModel
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

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

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

getPrimaryKeyObj

public 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
Specified by:
getPrimaryKeyObj in interface PollsChoiceModel
Returns:
the primary key of this model instance

setPrimaryKeyObj

public 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
Specified by:
setPrimaryKeyObj in interface PollsChoiceModel
Parameters:
primaryKeyObj - the primary key of this model instance

getExpandoBridge

public 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
Specified by:
getExpandoBridge in interface PollsChoiceModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

public 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>
Specified by:
setExpandoBridgeAttributes in interface PollsChoiceModel
Parameters:
serviceContext - the service context
See Also:
ServiceContext.getExpandoBridgeAttributes( )

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                                     throws LocaleException
Specified by:
prepareLocalizedFieldsForImport in interface PollsChoiceModel
Throws:
LocaleException

clone

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

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

compareTo

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

hashCode

public int hashCode()
Specified by:
hashCode in interface PollsChoiceModel
Overrides:
hashCode in class Object

toCacheModel

public 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>
Specified by:
toCacheModel in interface PollsChoiceModel
Returns:
the cache model object

toEscapedModel

public 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>
Specified by:
toEscapedModel in interface PollsChoiceModel
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

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

toString

public String toString()
Specified by:
toString in interface PollsChoiceModel
Overrides:
toString in class Object

toXmlString

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

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

persist

public void persist()
             throws SystemException
Description copied from interface: PersistedModel
Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:
persist in interface PersistedModel
Throws:
SystemException - if a system exception occurred

getVotesCount

public int getVotesCount()
                  throws SystemException
Specified by:
getVotesCount in interface PollsChoice
Throws:
SystemException

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

getWrappedPollsChoice

public PollsChoice getWrappedPollsChoice()
Deprecated. Renamed to getWrappedModel()


getWrappedModel

public PollsChoice getWrappedModel()
Specified by:
getWrappedModel in interface ModelWrapper<PollsChoice>

resetOriginalValues

public void resetOriginalValues()
Description copied from interface: BaseModel
Reset all original fields to current values.

Specified by:
resetOriginalValues in interface BaseModel<PollsChoice>

Liferay 6.1.2-ce-ga3