Liferay 6.0-ee-sp2

com.liferay.portlet.asset.model
Interface AssetEntryModel

All Superinterfaces:
AttachedModel, AuditedModel, BaseModel<AssetEntry>, ClassedModel, Cloneable, Comparable<AssetEntry>, GroupedModel, Serializable
All Known Subinterfaces:
AssetEntry
All Known Implementing Classes:
AssetEntryWrapper

public interface AssetEntryModel
extends AttachedModel, BaseModel<AssetEntry>, GroupedModel

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

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

See Also:
AssetEntry, AssetEntryImpl, AssetEntryModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(AssetEntry assetEntry)
           
 String getClassName()
          Gets the class name of the model instance this asset entry is polymorphically associated with.
 long getClassNameId()
          Gets the class name ID of this asset entry.
 long getClassPK()
          Gets the class p k of this asset entry.
 String getClassUuid()
          Gets the class uuid of this asset entry.
 long getCompanyId()
          Gets the company ID of this asset entry.
 Date getCreateDate()
          Gets the create date of this asset entry.
 String getDescription()
          Gets the description of this asset entry.
 Date getEndDate()
          Gets the end date of this asset entry.
 long getEntryId()
          Gets the entry ID of this asset entry.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 Date getExpirationDate()
          Gets the expiration date of this asset entry.
 long getGroupId()
          Gets the group ID of this asset entry.
 int getHeight()
          Gets the height of this asset entry.
 String getMimeType()
          Gets the mime type of this asset entry.
 Date getModifiedDate()
          Gets the modified date of this asset entry.
 long getPrimaryKey()
          Gets the primary key of this asset entry.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 double getPriority()
          Gets the priority of this asset entry.
 Date getPublishDate()
          Gets the publish date of this asset entry.
 Date getStartDate()
          Gets the start date of this asset entry.
 String getSummary()
          Gets the summary of this asset entry.
 String getTitle()
          Gets the title of this asset entry.
 String getTitle(Locale locale)
          Gets the localized title of this asset entry.
 String getTitle(Locale locale, boolean useDefault)
          Gets the localized title of this asset entry, optionally using the default language if no localization exists for the requested language.
 String getTitle(String languageId)
          Gets the localized title of this asset entry.
 String getTitle(String languageId, boolean useDefault)
          Gets the localized title of this asset entry, 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 entry.
 String getUrl()
          Gets the url of this asset entry.
 long getUserId()
          Gets the user ID of this asset entry.
 String getUserName()
          Gets the user name of this asset entry.
 String getUserUuid()
          Gets the user uuid of this asset entry.
 int getViewCount()
          Gets the view count of this asset entry.
 boolean getVisible()
          Gets the visible of this asset entry.
 int getWidth()
          Gets the width of this asset entry.
 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.
 boolean isVisible()
          Determines if this asset entry is visible.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setClassNameId(long classNameId)
          Sets the class name ID of this asset entry.
 void setClassPK(long classPK)
          Sets the class p k of this asset entry.
 void setClassUuid(String classUuid)
          Sets the class uuid of this asset entry.
 void setCompanyId(long companyId)
          Sets the company ID of this asset entry.
 void setCreateDate(Date createDate)
          Sets the create date of this asset entry.
 void setDescription(String description)
          Sets the description of this asset entry.
 void setEndDate(Date endDate)
          Sets the end date of this asset entry.
 void setEntryId(long entryId)
          Sets the entry ID of this asset entry.
 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 setExpirationDate(Date expirationDate)
          Sets the expiration date of this asset entry.
 void setGroupId(long groupId)
          Sets the group ID of this asset entry.
 void setHeight(int height)
          Sets the height of this asset entry.
 void setMimeType(String mimeType)
          Sets the mime type of this asset entry.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this asset entry.
 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 asset entry
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setPriority(double priority)
          Sets the priority of this asset entry.
 void setPublishDate(Date publishDate)
          Sets the publish date of this asset entry.
 void setStartDate(Date startDate)
          Sets the start date of this asset entry.
 void setSummary(String summary)
          Sets the summary of this asset entry.
 void setTitle(Locale locale, String title)
          Sets the localized title of this asset entry.
 void setTitle(String title)
          Sets the title of this asset entry.
 void setTitleMap(Map<Locale,String> titleMap)
          Sets the localized titles of this asset entry from the map of locales and localized titles.
 void setUrl(String url)
          Sets the url of this asset entry.
 void setUserId(long userId)
          Sets the user ID of this asset entry.
 void setUserName(String userName)
          Sets the user name of this asset entry.
 void setUserUuid(String userUuid)
          Sets the user uuid of this asset entry.
 void setViewCount(int viewCount)
          Sets the view count of this asset entry.
 void setVisible(boolean visible)
          Sets whether this asset entry is visible.
 void setWidth(int width)
          Sets the width of this asset entry.
 CacheModel<AssetEntry> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 AssetEntry toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
resetOriginalValues
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Gets the primary key of this asset entry.

Returns:
the primary key of this asset entry

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this asset entry

Parameters:
primaryKey - the primary key of this asset entry

getEntryId

long getEntryId()
Gets the entry ID of this asset entry.

Returns:
the entry ID of this asset entry

setEntryId

void setEntryId(long entryId)
Sets the entry ID of this asset entry.

Parameters:
entryId - the entry ID of this asset entry

getGroupId

long getGroupId()
Gets the group ID of this asset entry.

Specified by:
getGroupId in interface GroupedModel
Returns:
the group ID of this asset entry

setGroupId

void setGroupId(long groupId)
Sets the group ID of this asset entry.

Specified by:
setGroupId in interface GroupedModel
Parameters:
groupId - the group ID of this asset entry

getCompanyId

long getCompanyId()
Gets the company ID of this asset entry.

Specified by:
getCompanyId in interface AuditedModel
Returns:
the company ID of this asset entry

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this asset entry.

Specified by:
setCompanyId in interface AuditedModel
Parameters:
companyId - the company ID of this asset entry

getUserId

long getUserId()
Gets the user ID of this asset entry.

Specified by:
getUserId in interface AuditedModel
Returns:
the user ID of this asset entry

setUserId

void setUserId(long userId)
Sets the user ID of this asset entry.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this asset entry

getUserUuid

String getUserUuid()
                   throws SystemException
Gets the user uuid of this asset entry.

Specified by:
getUserUuid in interface AuditedModel
Returns:
the user uuid of this asset entry
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this asset entry.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this asset entry

getUserName

@AutoEscape
String getUserName()
Gets the user name of this asset entry.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this asset entry

setUserName

void setUserName(String userName)
Sets the user name of this asset entry.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this asset entry

getCreateDate

Date getCreateDate()
Gets the create date of this asset entry.

Specified by:
getCreateDate in interface AuditedModel
Returns:
the create date of this asset entry

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this asset entry.

Specified by:
setCreateDate in interface AuditedModel
Parameters:
createDate - the create date of this asset entry

getModifiedDate

Date getModifiedDate()
Gets the modified date of this asset entry.

Specified by:
getModifiedDate in interface AuditedModel
Returns:
the modified date of this asset entry

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this asset entry.

Specified by:
setModifiedDate in interface AuditedModel
Parameters:
modifiedDate - the modified date of this asset entry

getClassName

String getClassName()
Gets the class name of the model instance this asset entry is polymorphically associated with.

Specified by:
getClassName in interface AttachedModel
Returns:
the class name of the model instance this asset entry is polymorphically associated with

getClassNameId

long getClassNameId()
Gets the class name ID of this asset entry.

Specified by:
getClassNameId in interface AttachedModel
Returns:
the class name ID of this asset entry

setClassNameId

void setClassNameId(long classNameId)
Sets the class name ID of this asset entry.

Parameters:
classNameId - the class name ID of this asset entry

getClassPK

long getClassPK()
Gets the class p k of this asset entry.

Specified by:
getClassPK in interface AttachedModel
Returns:
the class p k of this asset entry

setClassPK

void setClassPK(long classPK)
Sets the class p k of this asset entry.

Parameters:
classPK - the class p k of this asset entry

getClassUuid

@AutoEscape
String getClassUuid()
Gets the class uuid of this asset entry.

Returns:
the class uuid of this asset entry

setClassUuid

void setClassUuid(String classUuid)
Sets the class uuid of this asset entry.

Parameters:
classUuid - the class uuid of this asset entry

getVisible

boolean getVisible()
Gets the visible of this asset entry.

Returns:
the visible of this asset entry

isVisible

boolean isVisible()
Determines if this asset entry is visible.

Returns:
true if this asset entry is visible; false otherwise

setVisible

void setVisible(boolean visible)
Sets whether this asset entry is visible.

Parameters:
visible - the visible of this asset entry

getStartDate

Date getStartDate()
Gets the start date of this asset entry.

Returns:
the start date of this asset entry

setStartDate

void setStartDate(Date startDate)
Sets the start date of this asset entry.

Parameters:
startDate - the start date of this asset entry

getEndDate

Date getEndDate()
Gets the end date of this asset entry.

Returns:
the end date of this asset entry

setEndDate

void setEndDate(Date endDate)
Sets the end date of this asset entry.

Parameters:
endDate - the end date of this asset entry

getPublishDate

Date getPublishDate()
Gets the publish date of this asset entry.

Returns:
the publish date of this asset entry

setPublishDate

void setPublishDate(Date publishDate)
Sets the publish date of this asset entry.

Parameters:
publishDate - the publish date of this asset entry

getExpirationDate

Date getExpirationDate()
Gets the expiration date of this asset entry.

Returns:
the expiration date of this asset entry

setExpirationDate

void setExpirationDate(Date expirationDate)
Sets the expiration date of this asset entry.

Parameters:
expirationDate - the expiration date of this asset entry

getMimeType

@AutoEscape
String getMimeType()
Gets the mime type of this asset entry.

Returns:
the mime type of this asset entry

setMimeType

void setMimeType(String mimeType)
Sets the mime type of this asset entry.

Parameters:
mimeType - the mime type of this asset entry

getTitle

String getTitle()
Gets the title of this asset entry.

Returns:
the title of this asset entry

getTitle

String getTitle(Locale locale)
Gets the localized title of this asset entry. 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 entry

getTitle

String getTitle(Locale locale,
                boolean useDefault)
Gets the localized title of this asset entry, 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 entry. 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 entry. 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 entry

getTitle

String getTitle(String languageId,
                boolean useDefault)
Gets the localized title of this asset entry, 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 entry

getTitleMap

Map<Locale,String> getTitleMap()
Gets a map of the locales and localized title of this asset entry.

Returns:
the locales and localized title

setTitle

void setTitle(String title)
Sets the title of this asset entry.

Parameters:
title - the title of this asset entry

setTitle

void setTitle(Locale locale,
              String title)
Sets the localized title of this asset entry.

Parameters:
locale - the locale to set the localized title for
title - the localized title of this asset entry

setTitleMap

void setTitleMap(Map<Locale,String> titleMap)
Sets the localized titles of this asset entry from the map of locales and localized titles.

Parameters:
titleMap - the locales and localized titles of this asset entry

getDescription

@AutoEscape
String getDescription()
Gets the description of this asset entry.

Returns:
the description of this asset entry

setDescription

void setDescription(String description)
Sets the description of this asset entry.

Parameters:
description - the description of this asset entry

getSummary

@AutoEscape
String getSummary()
Gets the summary of this asset entry.

Returns:
the summary of this asset entry

setSummary

void setSummary(String summary)
Sets the summary of this asset entry.

Parameters:
summary - the summary of this asset entry

getUrl

@AutoEscape
String getUrl()
Gets the url of this asset entry.

Returns:
the url of this asset entry

setUrl

void setUrl(String url)
Sets the url of this asset entry.

Parameters:
url - the url of this asset entry

getHeight

int getHeight()
Gets the height of this asset entry.

Returns:
the height of this asset entry

setHeight

void setHeight(int height)
Sets the height of this asset entry.

Parameters:
height - the height of this asset entry

getWidth

int getWidth()
Gets the width of this asset entry.

Returns:
the width of this asset entry

setWidth

void setWidth(int width)
Sets the width of this asset entry.

Parameters:
width - the width of this asset entry

getPriority

double getPriority()
Gets the priority of this asset entry.

Returns:
the priority of this asset entry

setPriority

void setPriority(double priority)
Sets the priority of this asset entry.

Parameters:
priority - the priority of this asset entry

getViewCount

int getViewCount()
Gets the view count of this asset entry.

Returns:
the view count of this asset entry

setViewCount

void setViewCount(int viewCount)
Sets the view count of this asset entry.

Parameters:
viewCount - the view count of this asset entry

isNew

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<AssetEntry>
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<AssetEntry>
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

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<AssetEntry>
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<AssetEntry>
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

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

Specified by:
isEscapedModel in interface BaseModel<AssetEntry>
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<AssetEntry>
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

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

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

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)
Description copied from interface: BaseModel
Sets the primary key of this model instance.

Specified by:
setPrimaryKeyObj in interface BaseModel<AssetEntry>
Specified by:
setPrimaryKeyObj in interface ClassedModel
Parameters:
primaryKeyObj - the primary key of this model instance

getExpandoBridge

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

Specified by:
getExpandoBridge in interface BaseModel<AssetEntry>
Specified by:
getExpandoBridge in interface ClassedModel
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<AssetEntry>
Parameters:
serviceContext - the service context
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<AssetEntry>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(AssetEntry assetEntry)
Specified by:
compareTo in interface Comparable<AssetEntry>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

CacheModel<AssetEntry> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<AssetEntry>
Returns:
the cache model object

toEscapedModel

AssetEntry 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<AssetEntry>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toString

String toString()
Overrides:
toString in class Object

toXmlString

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

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

Liferay 6.0-ee-sp2