com.liferay.portlet.asset.model
Interface AssetVocabularyModel

All Superinterfaces:

BaseModel<AssetVocabulary>, Cloneable, Comparable<AssetVocabulary>, Serializable

All Known Subinterfaces:

AssetVocabulary

All Known Implementing Classes:

AssetVocabularyImpl, AssetVocabularyModelImpl, AssetVocabularyWrapper

public interface AssetVocabularyModel
extends BaseModel<AssetVocabulary>

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

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

Never modify or reference this interface directly. All methods that expect a asset vocabulary model instance should use the AssetVocabulary interface instead.

See Also:

AssetVocabulary, AssetVocabularyImpl, AssetVocabularyModelImpl

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(AssetVocabulary assetVocabulary)
long	getCompanyId() Gets the company id of this asset vocabulary.
Date	getCreateDate() Gets the create date of this asset vocabulary.
String	getDescription() Gets the description of this asset vocabulary.
String	getDescription(Locale locale) Gets the localized description of this asset vocabulary.
String	getDescription(Locale locale, boolean useDefault) Gets the localized description of this asset vocabulary, optionally using the default language if no localization exists for the requested language.
String	getDescription(String languageId) Gets the localized description of this asset vocabulary.
String	getDescription(String languageId, boolean useDefault) Gets the localized description of this asset vocabulary, 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 asset vocabulary.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getGroupId() Gets the group id of this asset vocabulary.
Date	getModifiedDate() Gets the modified date of this asset vocabulary.
String	getName() Gets the name of this asset vocabulary.
long	getPrimaryKey() Gets the primary key of this asset vocabulary.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
String	getSettings() Gets the settings of this asset vocabulary.
String	getTitle() Gets the title of this asset vocabulary.
String	getTitle(Locale locale) Gets the localized title of this asset vocabulary.
String	getTitle(Locale locale, boolean useDefault) Gets the localized title of this asset vocabulary, optionally using the default language if no localization exists for the requested language.
String	getTitle(String languageId) Gets the localized title of this asset vocabulary.
String	getTitle(String languageId, boolean useDefault) Gets the localized title of this asset vocabulary, 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 asset vocabulary.
long	getUserId() Gets the user id of this asset vocabulary.
String	getUserName() Gets the user name of this asset vocabulary.
String	getUserUuid() Gets the user uuid of this asset vocabulary.
String	getUuid() Gets the uuid of this asset vocabulary.
long	getVocabularyId() Gets the vocabulary id of this asset vocabulary.
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	setCompanyId(long companyId) Sets the company id of this asset vocabulary.
void	setCreateDate(Date createDate) Sets the create date of this asset vocabulary.
void	setDescription(Locale locale, String description) Sets the localized description of this asset vocabulary.
void	setDescription(String description) Sets the description of this asset vocabulary.
void	setDescriptionMap(Map<Locale,String> descriptionMap) Sets the localized descriptions of this asset vocabulary 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	setGroupId(long groupId) Sets the group id of this asset vocabulary.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this asset vocabulary.
void	setName(String name) Sets the name of this asset vocabulary.
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 asset vocabulary
void	setSettings(String settings) Sets the settings of this asset vocabulary.
void	setTitle(Locale locale, String title) Sets the localized title of this asset vocabulary.
void	setTitle(String title) Sets the title of this asset vocabulary.
void	setTitleMap(Map<Locale,String> titleMap) Sets the localized titles of this asset vocabulary from the map of locales and localized titles.
void	setUserId(long userId) Sets the user id of this asset vocabulary.
void	setUserName(String userName) Sets the user name of this asset vocabulary.
void	setUserUuid(String userUuid) Sets the user uuid of this asset vocabulary.
void	setUuid(String uuid) Sets the uuid of this asset vocabulary.
void	setVocabularyId(long vocabularyId) Sets the vocabulary id of this asset vocabulary.
AssetVocabulary	toEscapedModel() Gets a copy of this asset vocabulary 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 asset vocabulary.

Returns:

the primary key of this asset vocabulary

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this asset vocabulary

Parameters:

pk - the primary key of this asset vocabulary

getUuid

@AutoEscape
String getUuid()

Gets the uuid of this asset vocabulary.

Returns:

the uuid of this asset vocabulary

setUuid

void setUuid(String uuid)

Sets the uuid of this asset vocabulary.

Parameters:

uuid - the uuid of this asset vocabulary

getVocabularyId

long getVocabularyId()

Gets the vocabulary id of this asset vocabulary.

Returns:

the vocabulary id of this asset vocabulary

setVocabularyId

void setVocabularyId(long vocabularyId)

Sets the vocabulary id of this asset vocabulary.

Parameters:

vocabularyId - the vocabulary id of this asset vocabulary

getGroupId

long getGroupId()

Gets the group id of this asset vocabulary.

Returns:

the group id of this asset vocabulary

setGroupId

void setGroupId(long groupId)

Sets the group id of this asset vocabulary.

Parameters:

groupId - the group id of this asset vocabulary

getCompanyId

long getCompanyId()

Gets the company id of this asset vocabulary.

Returns:

the company id of this asset vocabulary

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this asset vocabulary.

Parameters:

companyId - the company id of this asset vocabulary

getUserId

long getUserId()

Gets the user id of this asset vocabulary.

Returns:

the user id of this asset vocabulary

setUserId

void setUserId(long userId)

Sets the user id of this asset vocabulary.

Parameters:

userId - the user id of this asset vocabulary

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this asset vocabulary.

Returns:

the user uuid of this asset vocabulary

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this asset vocabulary.

Parameters:

userUuid - the user uuid of this asset vocabulary

getUserName

@AutoEscape
String getUserName()

Gets the user name of this asset vocabulary.

Returns:

the user name of this asset vocabulary

setUserName

void setUserName(String userName)

Sets the user name of this asset vocabulary.

Parameters:

userName - the user name of this asset vocabulary

getCreateDate

Date getCreateDate()

Gets the create date of this asset vocabulary.

Returns:

the create date of this asset vocabulary

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this asset vocabulary.

Parameters:

createDate - the create date of this asset vocabulary

getModifiedDate

Date getModifiedDate()

Gets the modified date of this asset vocabulary.

Returns:

the modified date of this asset vocabulary

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this asset vocabulary.

Parameters:

modifiedDate - the modified date of this asset vocabulary

getName

@AutoEscape
String getName()

Gets the name of this asset vocabulary.

Returns:

the name of this asset vocabulary

setName

void setName(String name)

Sets the name of this asset vocabulary.

Parameters:

name - the name of this asset vocabulary

getTitle

String getTitle()

Gets the title of this asset vocabulary.

Returns:

the title of this asset vocabulary

getTitle

String getTitle(Locale locale)

Gets the localized title of this asset vocabulary. 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 asset vocabulary

getTitle

String getTitle(Locale locale,
                boolean useDefault)

Gets the localized title of this asset vocabulary, 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 asset vocabulary. 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 asset vocabulary. 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 asset vocabulary

getTitle

String getTitle(String languageId,
                boolean useDefault)

Gets the localized title of this asset vocabulary, 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 asset vocabulary

getTitleMap

Map<Locale,String> getTitleMap()

Gets a map of the locales and localized title of this asset vocabulary.

Returns:

the locales and localized title

setTitle

void setTitle(String title)

Sets the title of this asset vocabulary.

Parameters:

title - the title of this asset vocabulary

setTitle

void setTitle(Locale locale,
              String title)

Sets the localized title of this asset vocabulary.

Parameters:

locale - the locale to set the localized title for

title - the localized title of this asset vocabulary

setTitleMap

void setTitleMap(Map<Locale,String> titleMap)

Sets the localized titles of this asset vocabulary from the map of locales and localized titles.

Parameters:

titleMap - the locales and localized titles of this asset vocabulary

getDescription

String getDescription()

Gets the description of this asset vocabulary.

Returns:

the description of this asset vocabulary

getDescription

String getDescription(Locale locale)

Gets the localized description of this asset vocabulary. 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 asset vocabulary

getDescription

String getDescription(Locale locale,
                      boolean useDefault)

Gets the localized description of this asset vocabulary, 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 asset vocabulary. 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 asset vocabulary. 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 asset vocabulary

getDescription

String getDescription(String languageId,
                      boolean useDefault)

Gets the localized description of this asset vocabulary, 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 asset vocabulary

getDescriptionMap

Map<Locale,String> getDescriptionMap()

Gets a map of the locales and localized description of this asset vocabulary.

Returns:

the locales and localized description

setDescription

void setDescription(String description)

Sets the description of this asset vocabulary.

Parameters:

description - the description of this asset vocabulary

setDescription

void setDescription(Locale locale,
                    String description)

Sets the localized description of this asset vocabulary.

Parameters:

locale - the locale to set the localized description for

description - the localized description of this asset vocabulary

setDescriptionMap

void setDescriptionMap(Map<Locale,String> descriptionMap)

Sets the localized descriptions of this asset vocabulary from the map of locales and localized descriptions.

Parameters:

descriptionMap - the locales and localized descriptions of this asset vocabulary

getSettings

@AutoEscape
String getSettings()

Gets the settings of this asset vocabulary.

Returns:

the settings of this asset vocabulary

setSettings

void setSettings(String settings)

Sets the settings of this asset vocabulary.

Parameters:

settings - the settings of this asset vocabulary

toEscapedModel

AssetVocabulary toEscapedModel()

Gets a copy of this asset vocabulary 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<AssetVocabulary>

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(AssetVocabulary assetVocabulary)

Specified by:

compareTo in interface Comparable<AssetVocabulary>

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

Returns:

the XML representation of this model instance