com.liferay.portlet.asset.model
Interface AssetCategoryModel

All Superinterfaces:

BaseModel<AssetCategory>, Cloneable, Comparable<AssetCategory>, Serializable

All Known Subinterfaces:

AssetCategory

All Known Implementing Classes:

AssetCategoryImpl, AssetCategoryModelImpl, AssetCategoryWrapper

public interface AssetCategoryModel
extends BaseModel<AssetCategory>

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

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

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

See Also:

AssetCategory, AssetCategoryImpl, AssetCategoryModelImpl

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(AssetCategory assetCategory)
long	getCategoryId() Gets the category id of this asset category.
long	getCompanyId() Gets the company id of this asset category.
Date	getCreateDate() Gets the create date of this asset category.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getGroupId() Gets the group id of this asset category.
long	getLeftCategoryId() Gets the left category id of this asset category.
Date	getModifiedDate() Gets the modified date of this asset category.
String	getName() Gets the name of this asset category.
long	getParentCategoryId() Gets the parent category id of this asset category.
long	getPrimaryKey() Gets the primary key of this asset category.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getRightCategoryId() Gets the right category id of this asset category.
String	getTitle() Gets the title of this asset category.
String	getTitle(Locale locale) Gets the localized title of this asset category.
String	getTitle(Locale locale, boolean useDefault) Gets the localized title of this asset category, optionally using the default language if no localization exists for the requested language.
String	getTitle(String languageId) Gets the localized title of this asset category.
String	getTitle(String languageId, boolean useDefault) Gets the localized title of this asset category, 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 category.
long	getUserId() Gets the user id of this asset category.
String	getUserName() Gets the user name of this asset category.
String	getUserUuid() Gets the user uuid of this asset category.
String	getUuid() Gets the uuid of this asset category.
long	getVocabularyId() Gets the vocabulary id of this asset category.
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	setCategoryId(long categoryId) Sets the category id of this asset category.
void	setCompanyId(long companyId) Sets the company id of this asset category.
void	setCreateDate(Date createDate) Sets the create date of this asset category.
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 category.
void	setLeftCategoryId(long leftCategoryId) Sets the left category id of this asset category.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this asset category.
void	setName(String name) Sets the name of this asset category.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setParentCategoryId(long parentCategoryId) Sets the parent category id of this asset category.
void	setPrimaryKey(long pk) Sets the primary key of this asset category
void	setRightCategoryId(long rightCategoryId) Sets the right category id of this asset category.
void	setTitle(Locale locale, String title) Sets the localized title of this asset category.
void	setTitle(String title) Sets the title of this asset category.
void	setTitleMap(Map<Locale,String> titleMap) Sets the localized titles of this asset category from the map of locales and localized titles.
void	setUserId(long userId) Sets the user id of this asset category.
void	setUserName(String userName) Sets the user name of this asset category.
void	setUserUuid(String userUuid) Sets the user uuid of this asset category.
void	setUuid(String uuid) Sets the uuid of this asset category.
void	setVocabularyId(long vocabularyId) Sets the vocabulary id of this asset category.
AssetCategory	toEscapedModel() Gets a copy of this asset category 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 category.

Returns:

the primary key of this asset category

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this asset category

Parameters:

pk - the primary key of this asset category

getUuid

@AutoEscape
String getUuid()

Gets the uuid of this asset category.

Returns:

the uuid of this asset category

setUuid

void setUuid(String uuid)

Sets the uuid of this asset category.

Parameters:

uuid - the uuid of this asset category

getCategoryId

long getCategoryId()

Gets the category id of this asset category.

Returns:

the category id of this asset category

setCategoryId

void setCategoryId(long categoryId)

Sets the category id of this asset category.

Parameters:

categoryId - the category id of this asset category

getGroupId

long getGroupId()

Gets the group id of this asset category.

Returns:

the group id of this asset category

setGroupId

void setGroupId(long groupId)

Sets the group id of this asset category.

Parameters:

groupId - the group id of this asset category

getCompanyId

long getCompanyId()

Gets the company id of this asset category.

Returns:

the company id of this asset category

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this asset category.

Parameters:

companyId - the company id of this asset category

getUserId

long getUserId()

Gets the user id of this asset category.

Returns:

the user id of this asset category

setUserId

void setUserId(long userId)

Sets the user id of this asset category.

Parameters:

userId - the user id of this asset category

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this asset category.

Returns:

the user uuid of this asset category

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this asset category.

Parameters:

userUuid - the user uuid of this asset category

getUserName

@AutoEscape
String getUserName()

Gets the user name of this asset category.

Returns:

the user name of this asset category

setUserName

void setUserName(String userName)

Sets the user name of this asset category.

Parameters:

userName - the user name of this asset category

getCreateDate

Date getCreateDate()

Gets the create date of this asset category.

Returns:

the create date of this asset category

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this asset category.

Parameters:

createDate - the create date of this asset category

getModifiedDate

Date getModifiedDate()

Gets the modified date of this asset category.

Returns:

the modified date of this asset category

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this asset category.

Parameters:

modifiedDate - the modified date of this asset category

getParentCategoryId

long getParentCategoryId()

Gets the parent category id of this asset category.

Returns:

the parent category id of this asset category

setParentCategoryId

void setParentCategoryId(long parentCategoryId)

Sets the parent category id of this asset category.

Parameters:

parentCategoryId - the parent category id of this asset category

getLeftCategoryId

long getLeftCategoryId()

Gets the left category id of this asset category.

Returns:

the left category id of this asset category

setLeftCategoryId

void setLeftCategoryId(long leftCategoryId)

Sets the left category id of this asset category.

Parameters:

leftCategoryId - the left category id of this asset category

getRightCategoryId

long getRightCategoryId()

Gets the right category id of this asset category.

Returns:

the right category id of this asset category

setRightCategoryId

void setRightCategoryId(long rightCategoryId)

Sets the right category id of this asset category.

Parameters:

rightCategoryId - the right category id of this asset category

getName

@AutoEscape
String getName()

Gets the name of this asset category.

Returns:

the name of this asset category

setName

void setName(String name)

Sets the name of this asset category.

Parameters:

name - the name of this asset category

getTitle

String getTitle()

Gets the title of this asset category.

Returns:

the title of this asset category

getTitle

String getTitle(Locale locale)

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

getTitle

String getTitle(Locale locale,
                boolean useDefault)

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

getTitle

String getTitle(String languageId,
                boolean useDefault)

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

getTitleMap

Map<Locale,String> getTitleMap()

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

Returns:

the locales and localized title

setTitle

void setTitle(String title)

Sets the title of this asset category.

Parameters:

title - the title of this asset category

setTitle

void setTitle(Locale locale,
              String title)

Sets the localized title of this asset category.

Parameters:

locale - the locale to set the localized title for

title - the localized title of this asset category

setTitleMap

void setTitleMap(Map<Locale,String> titleMap)

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

Parameters:

titleMap - the locales and localized titles of this asset category

getVocabularyId

long getVocabularyId()

Gets the vocabulary id of this asset category.

Returns:

the vocabulary id of this asset category

setVocabularyId

void setVocabularyId(long vocabularyId)

Sets the vocabulary id of this asset category.

Parameters:

vocabularyId - the vocabulary id of this asset category

toEscapedModel

AssetCategory toEscapedModel()

Gets a copy of this asset category 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<AssetCategory>

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(AssetCategory assetCategory)

Specified by:

compareTo in interface Comparable<AssetCategory>

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

Returns:

the XML representation of this model instance