Liferay 6.0.5

com.liferay.portlet.polls.model
Class PollsChoiceWrapper

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

public class PollsChoiceWrapper
extends Object
implements PollsChoice

This class is a wrapper for PollsChoice.

See Also:
PollsChoice, Serialized Form
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
PollsChoiceWrapper(PollsChoice pollsChoice)
           
 
Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(PollsChoice pollsChoice)
           
 long getChoiceId()
          Gets the choice id of this polls choice.
 String getDescription()
          Gets the description of this polls choice.
 String getDescription(Locale locale)
          Gets the localized description of this polls choice.
 String getDescription(Locale locale, boolean useDefault)
          Gets the localized description of this polls choice, optionally using the default language if no localization exists for the requested language.
 String getDescription(String languageId)
          Gets the localized description of this polls choice.
 String getDescription(String languageId, boolean useDefault)
          Gets the localized description of this polls choice, 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 choice.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getName()
          Gets the name of this polls choice.
 long getPrimaryKey()
          Gets the primary key of this polls choice.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 long getQuestionId()
          Gets the question id of this polls choice.
 String getUuid()
          Gets the uuid of this polls choice.
 int getVotesCount()
           
 PollsChoice getWrappedPollsChoice()
           
 int hashCode()
           
 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 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(Locale locale, String description)
          Sets the localized description of this polls choice.
 void setDescription(String description)
          Sets the description of this polls choice.
 void setDescriptionMap(Map<Locale,String> descriptionMap)
          Sets the localized descriptions of this polls choice 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 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 pk)
          Sets the primary key of this polls choice
 void setQuestionId(long questionId)
          Sets the question id of this polls choice.
 void setUuid(String uuid)
          Sets the uuid of this polls choice.
 PollsChoice toEscapedModel()
          Gets a copy of this polls choice as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PollsChoiceWrapper

public PollsChoiceWrapper(PollsChoice pollsChoice)
Method Detail

getPrimaryKey

public long getPrimaryKey()
Description copied from interface: PollsChoiceModel
Gets 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 pk)
Description copied from interface: PollsChoiceModel
Sets the primary key of this polls choice

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

getUuid

public String getUuid()
Description copied from interface: PollsChoiceModel
Gets 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)
Description copied from interface: PollsChoiceModel
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()
Description copied from interface: PollsChoiceModel
Gets 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)
Description copied from interface: PollsChoiceModel
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()
Description copied from interface: PollsChoiceModel
Gets 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)
Description copied from interface: PollsChoiceModel
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()
Description copied from interface: PollsChoiceModel
Gets 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)
Description copied from interface: PollsChoiceModel
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()
Description copied from interface: PollsChoiceModel
Gets 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)
Description copied from interface: PollsChoiceModel
Gets the localized description of this polls choice. Uses the default language if no localization exists for the requested language.

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

getDescription

public String getDescription(Locale locale,
                             boolean useDefault)
Description copied from interface: PollsChoiceModel
Gets the localized description of this polls choice, optionally using the default language if no localization exists for the requested language.

Specified by:
getDescription in interface PollsChoiceModel
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 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)
Description copied from interface: PollsChoiceModel
Gets the localized description of this polls choice. 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 to get the localized description for
Returns:
the localized description of this polls choice

getDescription

public String getDescription(String languageId,
                             boolean useDefault)
Description copied from interface: PollsChoiceModel
Gets the localized description of this polls choice, 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 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 choice

getDescriptionMap

public Map<Locale,String> getDescriptionMap()
Description copied from interface: PollsChoiceModel
Gets a map of the locales and localized description of this polls choice.

Specified by:
getDescriptionMap in interface PollsChoiceModel
Returns:
the locales and localized description

setDescription

public void setDescription(String description)
Description copied from interface: PollsChoiceModel
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(Locale locale,
                           String description)
Description copied from interface: PollsChoiceModel
Sets the localized description of this polls choice.

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

setDescriptionMap

public void setDescriptionMap(Map<Locale,String> descriptionMap)
Description copied from interface: PollsChoiceModel
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

toEscapedModel

public PollsChoice toEscapedModel()
Description copied from interface: PollsChoiceModel
Gets a copy of this polls choice as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface PollsChoiceModel
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

isNew

public 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<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
Determines 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
Determines 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
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

public 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<PollsChoice>
Specified by:
setEscapedModel in interface PollsChoiceModel
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

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

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

getExpandoBridge

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

Specified by:
getExpandoBridge in interface BaseModel<PollsChoice>
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 to retrieve the expando bridge attributes from
See Also:
ServiceContext.getExpandoBridgeAttributes( )

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

toString

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

toXmlString

public String toXmlString()
Description copied from interface: BaseModel
Gets 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

getVotesCount

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

getWrappedPollsChoice

public PollsChoice getWrappedPollsChoice()

Liferay 6.0.5