|
Liferay 6.2.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ProviderType public interface DDMStructureModel
The base model interface for the DDMStructure service. Represents a row in the "DDMStructure" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation DDMStructureModelImpl
exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in DDMStructureImpl
.
DDMStructure
,
DDMStructureImpl
,
DDMStructureModelImpl
Method Summary | |
---|---|
abstract Object |
clone()
Creates a shallow clone of this model instance. |
abstract int |
compareTo(DDMStructure ddmStructure)
|
abstract String[] |
getAvailableLanguageIds()
|
abstract String |
getClassName()
Returns the fully qualified class name of this d d m structure. |
abstract long |
getClassNameId()
Returns the class name ID of this d d m structure. |
abstract long |
getCompanyId()
Returns the company ID of this d d m structure. |
abstract Date |
getCreateDate()
Returns the create date of this d d m structure. |
abstract String |
getDefaultLanguageId()
|
abstract String |
getDescription()
Returns the description of this d d m structure. |
abstract String |
getDescription(Locale locale)
Returns the localized description of this d d m structure in the language. |
abstract String |
getDescription(Locale locale,
boolean useDefault)
Returns the localized description of this d d m structure in the language, optionally using the default language if no localization exists for the requested language. |
abstract String |
getDescription(String languageId)
Returns the localized description of this d d m structure in the language. |
abstract String |
getDescription(String languageId,
boolean useDefault)
Returns the localized description of this d d m structure in the language, optionally using the default language if no localization exists for the requested language. |
abstract String |
getDescriptionCurrentLanguageId()
|
abstract String |
getDescriptionCurrentValue()
|
abstract Map<Locale,String> |
getDescriptionMap()
Returns a map of the locales and localized descriptions of this d d m structure. |
abstract ExpandoBridge |
getExpandoBridge()
Returns the expando bridge for this model instance. |
abstract long |
getGroupId()
Returns the group ID of this d d m structure. |
abstract Date |
getModifiedDate()
Returns the modified date of this d d m structure. |
abstract String |
getName()
Returns the name of this d d m structure. |
abstract String |
getName(Locale locale)
Returns the localized name of this d d m structure in the language. |
abstract String |
getName(Locale locale,
boolean useDefault)
Returns the localized name of this d d m structure in the language, optionally using the default language if no localization exists for the requested language. |
abstract String |
getName(String languageId)
Returns the localized name of this d d m structure in the language. |
abstract String |
getName(String languageId,
boolean useDefault)
Returns the localized name of this d d m structure in the language, optionally using the default language if no localization exists for the requested language. |
abstract String |
getNameCurrentLanguageId()
|
abstract String |
getNameCurrentValue()
|
abstract Map<Locale,String> |
getNameMap()
Returns a map of the locales and localized names of this d d m structure. |
abstract long |
getParentStructureId()
Returns the parent structure ID of this d d m structure. |
abstract long |
getPrimaryKey()
Returns the primary key of this d d m structure. |
abstract Serializable |
getPrimaryKeyObj()
Returns the primary key of this model instance. |
abstract String |
getStorageType()
Returns the storage type of this d d m structure. |
abstract long |
getStructureId()
Returns the structure ID of this d d m structure. |
abstract String |
getStructureKey()
Returns the structure key of this d d m structure. |
abstract int |
getType()
Returns the type of this d d m structure. |
abstract long |
getUserId()
Returns the user ID of this d d m structure. |
abstract String |
getUserName()
Returns the user name of this d d m structure. |
abstract String |
getUserUuid()
Returns the user uuid of this d d m structure. |
abstract String |
getUuid()
Returns the uuid of this d d m structure. |
abstract String |
getXsd()
Returns the xsd of this d d m structure. |
abstract int |
hashCode()
|
abstract boolean |
isCachedModel()
Returns true if this model instance was retrieved from the
entity cache. |
abstract boolean |
isEscapedModel()
Returns true if this model instance is escaped. |
abstract boolean |
isNew()
Returns true if this model instance does not yet exist in
the database. |
abstract void |
prepareLocalizedFieldsForImport()
|
abstract void |
prepareLocalizedFieldsForImport(Locale defaultImportLocale)
|
abstract void |
setCachedModel(boolean cachedModel)
Sets whether this model instance was retrieved from the entity cache. |
abstract void |
setClassName(String className)
|
abstract void |
setClassNameId(long classNameId)
Sets the class name ID of this d d m structure. |
abstract void |
setCompanyId(long companyId)
Sets the company ID of this d d m structure. |
abstract void |
setCreateDate(Date createDate)
Sets the create date of this d d m structure. |
abstract void |
setDescription(String description)
Sets the description of this d d m structure. |
abstract void |
setDescription(String description,
Locale locale)
Sets the localized description of this d d m structure in the language. |
abstract void |
setDescription(String description,
Locale locale,
Locale defaultLocale)
Sets the localized description of this d d m structure in the language, and sets the default locale. |
abstract void |
setDescriptionCurrentLanguageId(String languageId)
|
abstract void |
setDescriptionMap(Map<Locale,String> descriptionMap)
Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions. |
abstract void |
setDescriptionMap(Map<Locale,String> descriptionMap,
Locale defaultLocale)
Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions, and sets the default locale. |
abstract void |
setExpandoBridgeAttributes(BaseModel<?> baseModel)
|
abstract void |
setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
|
abstract void |
setExpandoBridgeAttributes(ServiceContext serviceContext)
Sets the expando bridge attributes for this model instance to the attributes stored in the service context. |
abstract void |
setGroupId(long groupId)
Sets the group ID of this d d m structure. |
abstract void |
setModifiedDate(Date modifiedDate)
Sets the modified date of this d d m structure. |
abstract void |
setName(String name)
Sets the name of this d d m structure. |
abstract void |
setName(String name,
Locale locale)
Sets the localized name of this d d m structure in the language. |
abstract void |
setName(String name,
Locale locale,
Locale defaultLocale)
Sets the localized name of this d d m structure in the language, and sets the default locale. |
abstract void |
setNameCurrentLanguageId(String languageId)
|
abstract void |
setNameMap(Map<Locale,String> nameMap)
Sets the localized names of this d d m structure from the map of locales and localized names. |
abstract void |
setNameMap(Map<Locale,String> nameMap,
Locale defaultLocale)
Sets the localized names of this d d m structure from the map of locales and localized names, and sets the default locale. |
abstract void |
setNew(boolean n)
Sets whether this model instance does not yet exist in the database. |
abstract void |
setParentStructureId(long parentStructureId)
Sets the parent structure ID of this d d m structure. |
abstract void |
setPrimaryKey(long primaryKey)
Sets the primary key of this d d m structure. |
abstract void |
setPrimaryKeyObj(Serializable primaryKeyObj)
Sets the primary key of this model instance. |
abstract void |
setStorageType(String storageType)
Sets the storage type of this d d m structure. |
abstract void |
setStructureId(long structureId)
Sets the structure ID of this d d m structure. |
abstract void |
setStructureKey(String structureKey)
Sets the structure key of this d d m structure. |
abstract void |
setType(int type)
Sets the type of this d d m structure. |
abstract void |
setUserId(long userId)
Sets the user ID of this d d m structure. |
abstract void |
setUserName(String userName)
Sets the user name of this d d m structure. |
abstract void |
setUserUuid(String userUuid)
Sets the user uuid of this d d m structure. |
abstract void |
setUuid(String uuid)
Sets the uuid of this d d m structure. |
abstract void |
setXsd(String xsd)
Sets the xsd of this d d m structure. |
abstract CacheModel<DDMStructure> |
toCacheModel()
Returns a cache model object for this entity used by entity cache. |
abstract DDMStructure |
toEscapedModel()
Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler . |
abstract String |
toString()
|
abstract DDMStructure |
toUnescapedModel()
|
abstract 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 |
Methods inherited from interface com.liferay.portal.model.StagedModel |
---|
getStagedModelType |
Method Detail |
---|
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey
- the primary key of this d d m structure@AutoEscape String getUuid()
getUuid
in interface StagedModel
void setUuid(String uuid)
setUuid
in interface StagedModel
uuid
- the uuid of this d d m structurelong getStructureId()
void setStructureId(long structureId)
structureId
- the structure ID of this d d m structurelong getGroupId()
getGroupId
in interface GroupedModel
void setGroupId(long groupId)
setGroupId
in interface GroupedModel
groupId
- the group ID of this d d m structurelong getCompanyId()
getCompanyId
in interface AuditedModel
getCompanyId
in interface StagedModel
void setCompanyId(long companyId)
setCompanyId
in interface AuditedModel
setCompanyId
in interface StagedModel
companyId
- the company ID of this d d m structurelong getUserId()
getUserId
in interface AuditedModel
void setUserId(long userId)
setUserId
in interface AuditedModel
userId
- the user ID of this d d m structureString getUserUuid() throws SystemException
getUserUuid
in interface AuditedModel
SystemException
- if a system exception occurredvoid setUserUuid(String userUuid)
setUserUuid
in interface AuditedModel
userUuid
- the user uuid of this d d m structure@AutoEscape String getUserName()
getUserName
in interface AuditedModel
void setUserName(String userName)
setUserName
in interface AuditedModel
userName
- the user name of this d d m structureDate getCreateDate()
getCreateDate
in interface AuditedModel
getCreateDate
in interface StagedModel
void setCreateDate(Date createDate)
setCreateDate
in interface AuditedModel
setCreateDate
in interface StagedModel
createDate
- the create date of this d d m structureDate getModifiedDate()
getModifiedDate
in interface AuditedModel
getModifiedDate
in interface StagedModel
void setModifiedDate(Date modifiedDate)
setModifiedDate
in interface AuditedModel
setModifiedDate
in interface StagedModel
modifiedDate
- the modified date of this d d m structurelong getParentStructureId()
void setParentStructureId(long parentStructureId)
parentStructureId
- the parent structure ID of this d d m structureString getClassName()
getClassName
in interface TypedModel
void setClassName(String className)
long getClassNameId()
getClassNameId
in interface TypedModel
void setClassNameId(long classNameId)
setClassNameId
in interface TypedModel
classNameId
- the class name ID of this d d m structureString getStructureKey()
void setStructureKey(String structureKey)
structureKey
- the structure key of this d d m structureString getName()
@AutoEscape String getName(Locale locale)
locale
- the locale of the language
@AutoEscape String getName(Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language
useDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape String getName(String languageId)
languageId
- the ID of the language
@AutoEscape String getName(String languageId, boolean useDefault)
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language
@AutoEscape String getNameCurrentLanguageId()
@AutoEscape String getNameCurrentValue()
Map<Locale,String> getNameMap()
void setName(String name)
name
- the name of this d d m structurevoid setName(String name, Locale locale)
name
- the localized name of this d d m structurelocale
- the locale of the languagevoid setName(String name, Locale locale, Locale defaultLocale)
name
- the localized name of this d d m structurelocale
- the locale of the languagedefaultLocale
- the default localevoid setNameCurrentLanguageId(String languageId)
void setNameMap(Map<Locale,String> nameMap)
nameMap
- the locales and localized names of this d d m structurevoid setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
nameMap
- the locales and localized names of this d d m structuredefaultLocale
- the default localeString getDescription()
@AutoEscape String getDescription(Locale locale)
locale
- the locale of the language
@AutoEscape String getDescription(Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language
useDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape String getDescription(String languageId)
languageId
- the ID of the language
@AutoEscape String getDescription(String languageId, boolean useDefault)
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language
@AutoEscape String getDescriptionCurrentLanguageId()
@AutoEscape String getDescriptionCurrentValue()
Map<Locale,String> getDescriptionMap()
void setDescription(String description)
description
- the description of this d d m structurevoid setDescription(String description, Locale locale)
description
- the localized description of this d d m structurelocale
- the locale of the languagevoid setDescription(String description, Locale locale, Locale defaultLocale)
description
- the localized description of this d d m structurelocale
- the locale of the languagedefaultLocale
- the default localevoid setDescriptionCurrentLanguageId(String languageId)
void setDescriptionMap(Map<Locale,String> descriptionMap)
descriptionMap
- the locales and localized descriptions of this d d m structurevoid setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
descriptionMap
- the locales and localized descriptions of this d d m structuredefaultLocale
- the default locale@AutoEscape String getXsd()
void setXsd(String xsd)
xsd
- the xsd of this d d m structure@AutoEscape String getStorageType()
void setStorageType(String storageType)
storageType
- the storage type of this d d m structureint getType()
void setType(int type)
type
- the type of this d d m structureboolean isNew()
BaseModel
true
if this model instance does not yet exist in
the database.
isNew
in interface BaseModel<DDMStructure>
true
if this model instance does not yet exist in
the database; false
otherwisevoid setNew(boolean n)
BaseModel
setNew
in interface BaseModel<DDMStructure>
n
- whether this model instance does not yet exist in the databaseboolean isCachedModel()
BaseModel
true
if this model instance was retrieved from the
entity cache.
isCachedModel
in interface BaseModel<DDMStructure>
true
if this model instance was retrieved from the
entity cache; false
otherwiseBaseModel.setCachedModel(boolean)
void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel
in interface BaseModel<DDMStructure>
cachedModel
- whether this model instance was retrieved from the
entity cacheEntityCache
boolean isEscapedModel()
BaseModel
true
if this model instance is escaped.
isEscapedModel
in interface BaseModel<DDMStructure>
true
if this model instance is escaped;
false
otherwiseSerializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj
in interface BaseModel<DDMStructure>
getPrimaryKeyObj
in interface ClassedModel
void setPrimaryKeyObj(Serializable primaryKeyObj)
BaseModel
setPrimaryKeyObj
in interface BaseModel<DDMStructure>
setPrimaryKeyObj
in interface ClassedModel
primaryKeyObj
- the primary key of this model instanceExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge
in interface BaseModel<DDMStructure>
getExpandoBridge
in interface ClassedModel
void setExpandoBridgeAttributes(BaseModel<?> baseModel)
setExpandoBridgeAttributes
in interface BaseModel<DDMStructure>
void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
setExpandoBridgeAttributes
in interface BaseModel<DDMStructure>
void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes
in interface BaseModel<DDMStructure>
serviceContext
- the service context to be appliedServiceContext.getExpandoBridgeAttributes(
)
String[] getAvailableLanguageIds()
String getDefaultLanguageId()
void prepareLocalizedFieldsForImport() throws LocaleException
LocaleException
void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws LocaleException
LocaleException
Object clone()
BaseModel
clone
in interface BaseModel<DDMStructure>
clone
in interface StagedModel
int compareTo(DDMStructure ddmStructure)
compareTo
in interface Comparable<DDMStructure>
int hashCode()
hashCode
in class Object
CacheModel<DDMStructure> toCacheModel()
BaseModel
toCacheModel
in interface BaseModel<DDMStructure>
DDMStructure toEscapedModel()
BaseModel
AutoEscapeBeanHandler
.
toEscapedModel
in interface BaseModel<DDMStructure>
AutoEscapeBeanHandler
DDMStructure toUnescapedModel()
toUnescapedModel
in interface BaseModel<DDMStructure>
String toString()
toString
in class Object
String toXmlString()
BaseModel
toXmlString
in interface BaseModel<DDMStructure>
|
Liferay 6.2.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |