com.liferay.portlet.polls.model
Interface PollsChoiceModel

All Superinterfaces:

BaseModel<PollsChoice>, Cloneable, Comparable<PollsChoice>, Serializable

All Known Subinterfaces:

PollsChoice

All Known Implementing Classes:

PollsChoiceImpl, PollsChoiceModelImpl, 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.

Never modify or reference this interface directly. All methods that expect a polls choice model instance should use the PollsChoice interface instead.

See Also:

PollsChoice, PollsChoiceImpl, PollsChoiceModelImpl

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

Method Detail

getPrimaryKey

long getPrimaryKey()

Gets the primary key of this polls choice.

Returns:

the primary key of this polls choice

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this polls choice

Parameters:

pk - the primary key of this polls choice

getUuid

@AutoEscape
String getUuid()

Gets 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()

Gets 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()

Gets 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()

Gets 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()

Gets the description of this polls choice.

Returns:

the description of this polls choice

getDescription

String getDescription(Locale locale)

Gets the localized description of this polls choice. 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 choice

getDescription

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.

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

String getDescription(String languageId)

Gets the localized description of this polls choice. 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 choice

getDescription

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.

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

Map<Locale,String> getDescriptionMap()

Gets a map of the locales and localized description of this polls choice.

Returns:

the locales and localized description

setDescription

void setDescription(String description)

Sets the description of this polls choice.

Parameters:

description - the description of this polls choice

setDescription

void setDescription(Locale locale,
                    String description)

Sets the localized description of this polls choice.

Parameters:

locale - the locale to set the localized description for

description - the localized description of this polls choice

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

toEscapedModel

PollsChoice toEscapedModel()

Gets a copy of this polls choice 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<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

Determines 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

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<PollsChoice>

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<PollsChoice>

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<PollsChoice>

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<PollsChoice>

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

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<PollsChoice>

Returns:

the XML representation of this model instance