Liferay 6.2-ce-ga5

com.liferay.portal.model
Interface LayoutSetPrototypeModel

All Superinterfaces:
AuditedModel, BaseModel<LayoutSetPrototype>, ClassedModel, Cloneable, Comparable<LayoutSetPrototype>, Serializable, StagedAuditedModel, StagedModel
All Known Subinterfaces:
LayoutSetPrototype
All Known Implementing Classes:
LayoutSetPrototypeWrapper

@ProviderType
public interface LayoutSetPrototypeModel
extends BaseModel<LayoutSetPrototype>, StagedAuditedModel

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

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

See Also:
LayoutSetPrototype, LayoutSetPrototypeImpl, LayoutSetPrototypeModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(LayoutSetPrototype layoutSetPrototype)
           
 boolean getActive()
          Returns the active of this layout set prototype.
 String[] getAvailableLanguageIds()
           
 long getCompanyId()
          Returns the company ID of this layout set prototype.
 Date getCreateDate()
          Returns the create date of this layout set prototype.
 String getDefaultLanguageId()
           
 String getDescription()
          Returns the description of this layout set prototype.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getLayoutSetPrototypeId()
          Returns the layout set prototype ID of this layout set prototype.
 Date getModifiedDate()
          Returns the modified date of this layout set prototype.
 String getName()
          Returns the name of this layout set prototype.
 String getName(Locale locale)
          Returns the localized name of this layout set prototype in the language.
 String getName(Locale locale, boolean useDefault)
          Returns the localized name of this layout set prototype in the language, optionally using the default language if no localization exists for the requested language.
 String getName(String languageId)
          Returns the localized name of this layout set prototype in the language.
 String getName(String languageId, boolean useDefault)
          Returns the localized name of this layout set prototype in the language, optionally using the default language if no localization exists for the requested language.
 String getNameCurrentLanguageId()
           
 String getNameCurrentValue()
           
 Map<Locale,String> getNameMap()
          Returns a map of the locales and localized names of this layout set prototype.
 long getPrimaryKey()
          Returns the primary key of this layout set prototype.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 String getSettings()
          Returns the settings of this layout set prototype.
 long getUserId()
          Returns the user ID of this layout set prototype.
 String getUserName()
          Returns the user name of this layout set prototype.
 String getUserUuid()
          Returns the user uuid of this layout set prototype.
 String getUuid()
          Returns the uuid of this layout set prototype.
 int hashCode()
           
 boolean isActive()
          Returns true if this layout set prototype is active.
 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.
 void prepareLocalizedFieldsForImport()
           
 void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
           
 void setActive(boolean active)
          Sets whether this layout set prototype is active.
 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 layout set prototype.
 void setCreateDate(Date createDate)
          Sets the create date of this layout set prototype.
 void setDescription(String description)
          Sets the description of this layout set prototype.
 void setExpandoBridgeAttributes(BaseModel<?> baseModel)
           
 void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
           
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setLayoutSetPrototypeId(long layoutSetPrototypeId)
          Sets the layout set prototype ID of this layout set prototype.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this layout set prototype.
 void setName(String name)
          Sets the name of this layout set prototype.
 void setName(String name, Locale locale)
          Sets the localized name of this layout set prototype in the language.
 void setName(String name, Locale locale, Locale defaultLocale)
          Sets the localized name of this layout set prototype in the language, and sets the default locale.
 void setNameCurrentLanguageId(String languageId)
           
 void setNameMap(Map<Locale,String> nameMap)
          Sets the localized names of this layout set prototype from the map of locales and localized names.
 void setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
          Sets the localized names of this layout set prototype from the map of locales and localized names, and sets the default locale.
 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 layout set prototype.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setSettings(String settings)
          Sets the settings of this layout set prototype.
 void setUserId(long userId)
          Sets the user ID of this layout set prototype.
 void setUserName(String userName)
          Sets the user name of this layout set prototype.
 void setUserUuid(String userUuid)
          Sets the user uuid of this layout set prototype.
 void setUuid(String uuid)
          Sets the uuid of this layout set prototype.
 CacheModel<LayoutSetPrototype> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 LayoutSetPrototype toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 LayoutSetPrototype toUnescapedModel()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.model.StagedModel
getStagedModelType
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Returns the primary key of this layout set prototype.

Returns:
the primary key of this layout set prototype

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this layout set prototype.

Parameters:
primaryKey - the primary key of this layout set prototype

getUuid

@AutoEscape
String getUuid()
Returns the uuid of this layout set prototype.

Specified by:
getUuid in interface StagedModel
Returns:
the uuid of this layout set prototype

setUuid

void setUuid(String uuid)
Sets the uuid of this layout set prototype.

Specified by:
setUuid in interface StagedModel
Parameters:
uuid - the uuid of this layout set prototype

getLayoutSetPrototypeId

long getLayoutSetPrototypeId()
Returns the layout set prototype ID of this layout set prototype.

Returns:
the layout set prototype ID of this layout set prototype

setLayoutSetPrototypeId

void setLayoutSetPrototypeId(long layoutSetPrototypeId)
Sets the layout set prototype ID of this layout set prototype.

Parameters:
layoutSetPrototypeId - the layout set prototype ID of this layout set prototype

getCompanyId

long getCompanyId()
Returns the company ID of this layout set prototype.

Specified by:
getCompanyId in interface AuditedModel
Specified by:
getCompanyId in interface StagedModel
Returns:
the company ID of this layout set prototype

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this layout set prototype.

Specified by:
setCompanyId in interface AuditedModel
Specified by:
setCompanyId in interface StagedModel
Parameters:
companyId - the company ID of this layout set prototype

getUserId

long getUserId()
Returns the user ID of this layout set prototype.

Specified by:
getUserId in interface AuditedModel
Returns:
the user ID of this layout set prototype

setUserId

void setUserId(long userId)
Sets the user ID of this layout set prototype.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this layout set prototype

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this layout set prototype.

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

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this layout set prototype.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this layout set prototype

getUserName

@AutoEscape
String getUserName()
Returns the user name of this layout set prototype.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this layout set prototype

setUserName

void setUserName(String userName)
Sets the user name of this layout set prototype.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this layout set prototype

getCreateDate

Date getCreateDate()
Returns the create date of this layout set prototype.

Specified by:
getCreateDate in interface AuditedModel
Specified by:
getCreateDate in interface StagedModel
Returns:
the create date of this layout set prototype

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this layout set prototype.

Specified by:
setCreateDate in interface AuditedModel
Specified by:
setCreateDate in interface StagedModel
Parameters:
createDate - the create date of this layout set prototype

getModifiedDate

Date getModifiedDate()
Returns the modified date of this layout set prototype.

Specified by:
getModifiedDate in interface AuditedModel
Specified by:
getModifiedDate in interface StagedModel
Returns:
the modified date of this layout set prototype

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this layout set prototype.

Specified by:
setModifiedDate in interface AuditedModel
Specified by:
setModifiedDate in interface StagedModel
Parameters:
modifiedDate - the modified date of this layout set prototype

getName

String getName()
Returns the name of this layout set prototype.

Returns:
the name of this layout set prototype

getName

@AutoEscape
String getName(Locale locale)
Returns the localized name of this layout set prototype in the language. Uses the default language if no localization exists for the requested language.

Parameters:
locale - the locale of the language
Returns:
the localized name of this layout set prototype

getName

@AutoEscape
String getName(Locale locale,
                          boolean useDefault)
Returns the localized name of this layout set prototype in the language, optionally using the default language if no localization exists for the requested language.

Parameters:
locale - the local of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized name of this layout set prototype. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getName

@AutoEscape
String getName(String languageId)
Returns the localized name of this layout set prototype in the language. Uses the default language if no localization exists for the requested language.

Parameters:
languageId - the ID of the language
Returns:
the localized name of this layout set prototype

getName

@AutoEscape
String getName(String languageId,
                          boolean useDefault)
Returns the localized name of this layout set prototype in the language, optionally using the default language if no localization exists for the requested language.

Parameters:
languageId - the ID of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized name of this layout set prototype

getNameCurrentLanguageId

@AutoEscape
String getNameCurrentLanguageId()

getNameCurrentValue

@AutoEscape
String getNameCurrentValue()

getNameMap

Map<Locale,String> getNameMap()
Returns a map of the locales and localized names of this layout set prototype.

Returns:
the locales and localized names of this layout set prototype

setName

void setName(String name)
Sets the name of this layout set prototype.

Parameters:
name - the name of this layout set prototype

setName

void setName(String name,
             Locale locale)
Sets the localized name of this layout set prototype in the language.

Parameters:
name - the localized name of this layout set prototype
locale - the locale of the language

setName

void setName(String name,
             Locale locale,
             Locale defaultLocale)
Sets the localized name of this layout set prototype in the language, and sets the default locale.

Parameters:
name - the localized name of this layout set prototype
locale - the locale of the language
defaultLocale - the default locale

setNameCurrentLanguageId

void setNameCurrentLanguageId(String languageId)

setNameMap

void setNameMap(Map<Locale,String> nameMap)
Sets the localized names of this layout set prototype from the map of locales and localized names.

Parameters:
nameMap - the locales and localized names of this layout set prototype

setNameMap

void setNameMap(Map<Locale,String> nameMap,
                Locale defaultLocale)
Sets the localized names of this layout set prototype from the map of locales and localized names, and sets the default locale.

Parameters:
nameMap - the locales and localized names of this layout set prototype
defaultLocale - the default locale

getDescription

@AutoEscape
String getDescription()
Returns the description of this layout set prototype.

Returns:
the description of this layout set prototype

setDescription

void setDescription(String description)
Sets the description of this layout set prototype.

Parameters:
description - the description of this layout set prototype

getSettings

@AutoEscape
String getSettings()
Returns the settings of this layout set prototype.

Returns:
the settings of this layout set prototype

setSettings

void setSettings(String settings)
Sets the settings of this layout set prototype.

Parameters:
settings - the settings of this layout set prototype

getActive

boolean getActive()
Returns the active of this layout set prototype.

Returns:
the active of this layout set prototype

isActive

boolean isActive()
Returns true if this layout set prototype is active.

Returns:
true if this layout set prototype is active; false otherwise

setActive

void setActive(boolean active)
Sets whether this layout set prototype is active.

Parameters:
active - the active of this layout set prototype

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<LayoutSetPrototype>
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<LayoutSetPrototype>
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<LayoutSetPrototype>
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<LayoutSetPrototype>
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<LayoutSetPrototype>
Returns:
true if this model instance is escaped; false otherwise

getPrimaryKeyObj

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

Specified by:
getPrimaryKeyObj in interface BaseModel<LayoutSetPrototype>
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<LayoutSetPrototype>
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<LayoutSetPrototype>
Specified by:
getExpandoBridge in interface ClassedModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<LayoutSetPrototype>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<LayoutSetPrototype>

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<LayoutSetPrototype>
Parameters:
serviceContext - the service context to be applied
See Also:
ServiceContext.getExpandoBridgeAttributes( )

getAvailableLanguageIds

String[] getAvailableLanguageIds()

getDefaultLanguageId

String getDefaultLanguageId()

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport()
                                     throws LocaleException
Throws:
LocaleException

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                                     throws LocaleException
Throws:
LocaleException

clone

Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<LayoutSetPrototype>
Specified by:
clone in interface StagedModel
Returns:
the shallow clone of this model instance

compareTo

int compareTo(LayoutSetPrototype layoutSetPrototype)
Specified by:
compareTo in interface Comparable<LayoutSetPrototype>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

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

toUnescapedModel

LayoutSetPrototype toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<LayoutSetPrototype>

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<LayoutSetPrototype>
Returns:
the XML representation of this model instance

Liferay 6.2-ce-ga5