Liferay 6.1.2-ce-ga3

com.liferay.portlet.dynamicdatalists.model
Interface DDLRecordSetModel

All Superinterfaces:
AuditedModel, BaseModel<DDLRecordSet>, ClassedModel, Cloneable, Comparable<DDLRecordSet>, GroupedModel, Serializable
All Known Subinterfaces:
DDLRecordSet
All Known Implementing Classes:
DDLRecordSetWrapper

public interface DDLRecordSetModel
extends BaseModel<DDLRecordSet>, GroupedModel

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

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

See Also:
DDLRecordSet, DDLRecordSetImpl, DDLRecordSetModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(DDLRecordSet ddlRecordSet)
           
 long getCompanyId()
          Returns the company ID of this d d l record set.
 Date getCreateDate()
          Returns the create date of this d d l record set.
 long getDDMStructureId()
          Returns the d d m structure ID of this d d l record set.
 String getDescription()
          Returns the description of this d d l record set.
 String getDescription(Locale locale)
          Returns the localized description of this d d l record set in the language.
 String getDescription(Locale locale, boolean useDefault)
          Returns the localized description of this d d l record set in the language, optionally using the default language if no localization exists for the requested language.
 String getDescription(String languageId)
          Returns the localized description of this d d l record set in the language.
 String getDescription(String languageId, boolean useDefault)
          Returns the localized description of this d d l record set in the language, optionally using the default language if no localization exists for the requested language.
 String getDescriptionCurrentLanguageId()
           
 String getDescriptionCurrentValue()
           
 Map<Locale,String> getDescriptionMap()
          Returns a map of the locales and localized descriptions of this d d l record set.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getGroupId()
          Returns the group ID of this d d l record set.
 int getMinDisplayRows()
          Returns the min display rows of this d d l record set.
 Date getModifiedDate()
          Returns the modified date of this d d l record set.
 String getName()
          Returns the name of this d d l record set.
 String getName(Locale locale)
          Returns the localized name of this d d l record set in the language.
 String getName(Locale locale, boolean useDefault)
          Returns the localized name of this d d l record set 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 d d l record set in the language.
 String getName(String languageId, boolean useDefault)
          Returns the localized name of this d d l record set 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 d d l record set.
 long getPrimaryKey()
          Returns the primary key of this d d l record set.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getRecordSetId()
          Returns the record set ID of this d d l record set.
 String getRecordSetKey()
          Returns the record set key of this d d l record set.
 int getScope()
          Returns the scope of this d d l record set.
 long getUserId()
          Returns the user ID of this d d l record set.
 String getUserName()
          Returns the user name of this d d l record set.
 String getUserUuid()
          Returns the user uuid of this d d l record set.
 String getUuid()
          Returns the uuid of this d d l record set.
 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.
 void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
           
 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 d d l record set.
 void setCreateDate(Date createDate)
          Sets the create date of this d d l record set.
 void setDDMStructureId(long DDMStructureId)
          Sets the d d m structure ID of this d d l record set.
 void setDescription(String description)
          Sets the description of this d d l record set.
 void setDescription(String description, Locale locale)
          Sets the localized description of this d d l record set in the language.
 void setDescription(String description, Locale locale, Locale defaultLocale)
          Sets the localized description of this d d l record set in the language, and sets the default locale.
 void setDescriptionCurrentLanguageId(String languageId)
           
 void setDescriptionMap(Map<Locale,String> descriptionMap)
          Sets the localized descriptions of this d d l record set from the map of locales and localized descriptions.
 void setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
          Sets the localized descriptions of this d d l record set from the map of locales and localized descriptions, and sets the default locale.
 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 d d l record set.
 void setMinDisplayRows(int minDisplayRows)
          Sets the min display rows of this d d l record set.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this d d l record set.
 void setName(String name)
          Sets the name of this d d l record set.
 void setName(String name, Locale locale)
          Sets the localized name of this d d l record set in the language.
 void setName(String name, Locale locale, Locale defaultLocale)
          Sets the localized name of this d d l record set in the language, and sets the default locale.
 void setNameCurrentLanguageId(String languageId)
           
 void setNameMap(Map<Locale,String> nameMap)
          Sets the localized names of this d d l record set from the map of locales and localized names.
 void setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
          Sets the localized names of this d d l record set 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 d d l record set.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setRecordSetId(long recordSetId)
          Sets the record set ID of this d d l record set.
 void setRecordSetKey(String recordSetKey)
          Sets the record set key of this d d l record set.
 void setScope(int scope)
          Sets the scope of this d d l record set.
 void setUserId(long userId)
          Sets the user ID of this d d l record set.
 void setUserName(String userName)
          Sets the user name of this d d l record set.
 void setUserUuid(String userUuid)
          Sets the user uuid of this d d l record set.
 void setUuid(String uuid)
          Sets the uuid of this d d l record set.
 CacheModel<DDLRecordSet> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 DDLRecordSet toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 DDLRecordSet 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.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Returns the primary key of this d d l record set.

Returns:
the primary key of this d d l record set

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this d d l record set.

Parameters:
primaryKey - the primary key of this d d l record set

getUuid

@AutoEscape
String getUuid()
Returns the uuid of this d d l record set.

Returns:
the uuid of this d d l record set

setUuid

void setUuid(String uuid)
Sets the uuid of this d d l record set.

Parameters:
uuid - the uuid of this d d l record set

getRecordSetId

long getRecordSetId()
Returns the record set ID of this d d l record set.

Returns:
the record set ID of this d d l record set

setRecordSetId

void setRecordSetId(long recordSetId)
Sets the record set ID of this d d l record set.

Parameters:
recordSetId - the record set ID of this d d l record set

getGroupId

long getGroupId()
Returns the group ID of this d d l record set.

Specified by:
getGroupId in interface GroupedModel
Returns:
the group ID of this d d l record set

setGroupId

void setGroupId(long groupId)
Sets the group ID of this d d l record set.

Specified by:
setGroupId in interface GroupedModel
Parameters:
groupId - the group ID of this d d l record set

getCompanyId

long getCompanyId()
Returns the company ID of this d d l record set.

Specified by:
getCompanyId in interface AuditedModel
Returns:
the company ID of this d d l record set

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this d d l record set.

Specified by:
setCompanyId in interface AuditedModel
Parameters:
companyId - the company ID of this d d l record set

getUserId

long getUserId()
Returns the user ID of this d d l record set.

Specified by:
getUserId in interface AuditedModel
Returns:
the user ID of this d d l record set

setUserId

void setUserId(long userId)
Sets the user ID of this d d l record set.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this d d l record set

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this d d l record set.

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

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this d d l record set.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this d d l record set

getUserName

@AutoEscape
String getUserName()
Returns the user name of this d d l record set.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this d d l record set

setUserName

void setUserName(String userName)
Sets the user name of this d d l record set.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this d d l record set

getCreateDate

Date getCreateDate()
Returns the create date of this d d l record set.

Specified by:
getCreateDate in interface AuditedModel
Returns:
the create date of this d d l record set

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this d d l record set.

Specified by:
setCreateDate in interface AuditedModel
Parameters:
createDate - the create date of this d d l record set

getModifiedDate

Date getModifiedDate()
Returns the modified date of this d d l record set.

Specified by:
getModifiedDate in interface AuditedModel
Returns:
the modified date of this d d l record set

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this d d l record set.

Specified by:
setModifiedDate in interface AuditedModel
Parameters:
modifiedDate - the modified date of this d d l record set

getDDMStructureId

long getDDMStructureId()
Returns the d d m structure ID of this d d l record set.

Returns:
the d d m structure ID of this d d l record set

setDDMStructureId

void setDDMStructureId(long DDMStructureId)
Sets the d d m structure ID of this d d l record set.

Parameters:
DDMStructureId - the d d m structure ID of this d d l record set

getRecordSetKey

String getRecordSetKey()
Returns the record set key of this d d l record set.

Returns:
the record set key of this d d l record set

setRecordSetKey

void setRecordSetKey(String recordSetKey)
Sets the record set key of this d d l record set.

Parameters:
recordSetKey - the record set key of this d d l record set

getName

String getName()
Returns the name of this d d l record set.

Returns:
the name of this d d l record set

getName

@AutoEscape
String getName(Locale locale)
Returns the localized name of this d d l record set 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 d d l record set

getName

@AutoEscape
String getName(Locale locale,
                          boolean useDefault)
Returns the localized name of this d d l record set 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 d d l record set. 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 d d l record set 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 d d l record set

getName

@AutoEscape
String getName(String languageId,
                          boolean useDefault)
Returns the localized name of this d d l record set 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 d d l record set

getNameCurrentLanguageId

@AutoEscape
String getNameCurrentLanguageId()

getNameCurrentValue

@AutoEscape
String getNameCurrentValue()

getNameMap

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

Returns:
the locales and localized names of this d d l record set

setName

void setName(String name)
Sets the name of this d d l record set.

Parameters:
name - the name of this d d l record set

setName

void setName(String name,
             Locale locale)
Sets the localized name of this d d l record set in the language.

Parameters:
name - the localized name of this d d l record set
locale - the locale of the language

setName

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

Parameters:
name - the localized name of this d d l record set
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 d d l record set from the map of locales and localized names.

Parameters:
nameMap - the locales and localized names of this d d l record set

setNameMap

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

Parameters:
nameMap - the locales and localized names of this d d l record set
defaultLocale - the default locale

getDescription

String getDescription()
Returns the description of this d d l record set.

Returns:
the description of this d d l record set

getDescription

@AutoEscape
String getDescription(Locale locale)
Returns the localized description of this d d l record set 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 description of this d d l record set

getDescription

@AutoEscape
String getDescription(Locale locale,
                                 boolean useDefault)
Returns the localized description of this d d l record set 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 description of this d d l record set. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getDescription

@AutoEscape
String getDescription(String languageId)
Returns the localized description of this d d l record set 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 description of this d d l record set

getDescription

@AutoEscape
String getDescription(String languageId,
                                 boolean useDefault)
Returns the localized description of this d d l record set 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 description of this d d l record set

getDescriptionCurrentLanguageId

@AutoEscape
String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue

@AutoEscape
String getDescriptionCurrentValue()

getDescriptionMap

Map<Locale,String> getDescriptionMap()
Returns a map of the locales and localized descriptions of this d d l record set.

Returns:
the locales and localized descriptions of this d d l record set

setDescription

void setDescription(String description)
Sets the description of this d d l record set.

Parameters:
description - the description of this d d l record set

setDescription

void setDescription(String description,
                    Locale locale)
Sets the localized description of this d d l record set in the language.

Parameters:
description - the localized description of this d d l record set
locale - the locale of the language

setDescription

void setDescription(String description,
                    Locale locale,
                    Locale defaultLocale)
Sets the localized description of this d d l record set in the language, and sets the default locale.

Parameters:
description - the localized description of this d d l record set
locale - the locale of the language
defaultLocale - the default locale

setDescriptionCurrentLanguageId

void setDescriptionCurrentLanguageId(String languageId)

setDescriptionMap

void setDescriptionMap(Map<Locale,String> descriptionMap)
Sets the localized descriptions of this d d l record set from the map of locales and localized descriptions.

Parameters:
descriptionMap - the locales and localized descriptions of this d d l record set

setDescriptionMap

void setDescriptionMap(Map<Locale,String> descriptionMap,
                       Locale defaultLocale)
Sets the localized descriptions of this d d l record set from the map of locales and localized descriptions, and sets the default locale.

Parameters:
descriptionMap - the locales and localized descriptions of this d d l record set
defaultLocale - the default locale

getMinDisplayRows

int getMinDisplayRows()
Returns the min display rows of this d d l record set.

Returns:
the min display rows of this d d l record set

setMinDisplayRows

void setMinDisplayRows(int minDisplayRows)
Sets the min display rows of this d d l record set.

Parameters:
minDisplayRows - the min display rows of this d d l record set

getScope

int getScope()
Returns the scope of this d d l record set.

Returns:
the scope of this d d l record set

setScope

void setScope(int scope)
Sets the scope of this d d l record set.

Parameters:
scope - the scope of this d d l record set

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

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<DDLRecordSet>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(DDLRecordSet ddlRecordSet)
Specified by:
compareTo in interface Comparable<DDLRecordSet>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

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

toUnescapedModel

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

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

Liferay 6.1.2-ce-ga3