@ProviderType public interface ObjectFieldModel extends com.liferay.portal.kernel.model.BaseModel<ObjectField>, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel
This interface and its corresponding implementation com.liferay.object.model.impl.ObjectFieldModelImpl
exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.object.model.impl.ObjectFieldImpl
.
ObjectField
Modifier and Type | Method and Description |
---|---|
ObjectField |
cloneWithOriginalValues() |
java.lang.String[] |
getAvailableLanguageIds() |
java.lang.String |
getBusinessType()
Returns the business type of this object field.
|
long |
getCompanyId()
Returns the company ID of this object field.
|
java.util.Date |
getCreateDate()
Returns the create date of this object field.
|
java.lang.String |
getDBColumnName()
Returns the db column name of this object field.
|
java.lang.String |
getDBTableName()
Returns the db table name of this object field.
|
java.lang.String |
getDBType()
Returns the db type of this object field.
|
java.lang.String |
getDefaultLanguageId() |
boolean |
getIndexed()
Returns the indexed of this object field.
|
boolean |
getIndexedAsKeyword()
Returns the indexed as keyword of this object field.
|
java.lang.String |
getIndexedLanguageId()
Returns the indexed language ID of this object field.
|
java.lang.String |
getLabel()
Returns the label of this object field.
|
java.lang.String |
getLabel(java.util.Locale locale)
Returns the localized label of this object field in the language.
|
java.lang.String |
getLabel(java.util.Locale locale,
boolean useDefault)
Returns the localized label of this object field in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getLabel(java.lang.String languageId)
Returns the localized label of this object field in the language.
|
java.lang.String |
getLabel(java.lang.String languageId,
boolean useDefault)
Returns the localized label of this object field in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getLabelCurrentLanguageId() |
java.lang.String |
getLabelCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getLabelMap()
Returns a map of the locales and localized labels of this object field.
|
long |
getListTypeDefinitionId()
Returns the list type definition ID of this object field.
|
java.util.Date |
getModifiedDate()
Returns the modified date of this object field.
|
long |
getMvccVersion()
Returns the mvcc version of this object field.
|
java.lang.String |
getName()
Returns the name of this object field.
|
long |
getObjectDefinitionId()
Returns the object definition ID of this object field.
|
long |
getObjectFieldId()
Returns the object field ID of this object field.
|
long |
getPrimaryKey()
Returns the primary key of this object field.
|
java.lang.String |
getRelationshipType()
Returns the relationship type of this object field.
|
boolean |
getRequired()
Returns the required of this object field.
|
long |
getUserId()
Returns the user ID of this object field.
|
java.lang.String |
getUserName()
Returns the user name of this object field.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this object field.
|
java.lang.String |
getUuid()
Returns the uuid of this object field.
|
boolean |
isIndexed()
Returns
true if this object field is indexed. |
boolean |
isIndexedAsKeyword()
Returns
true if this object field is indexed as keyword. |
boolean |
isRequired()
Returns
true if this object field is required. |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
void |
setBusinessType(java.lang.String businessType)
Sets the business type of this object field.
|
void |
setCompanyId(long companyId)
Sets the company ID of this object field.
|
void |
setCreateDate(java.util.Date createDate)
Sets the create date of this object field.
|
void |
setDBColumnName(java.lang.String dbColumnName)
Sets the db column name of this object field.
|
void |
setDBTableName(java.lang.String dbTableName)
Sets the db table name of this object field.
|
void |
setDBType(java.lang.String dbType)
Sets the db type of this object field.
|
void |
setIndexed(boolean indexed)
Sets whether this object field is indexed.
|
void |
setIndexedAsKeyword(boolean indexedAsKeyword)
Sets whether this object field is indexed as keyword.
|
void |
setIndexedLanguageId(java.lang.String indexedLanguageId)
Sets the indexed language ID of this object field.
|
void |
setLabel(java.lang.String label)
Sets the label of this object field.
|
void |
setLabel(java.lang.String label,
java.util.Locale locale)
Sets the localized label of this object field in the language.
|
void |
setLabel(java.lang.String label,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized label of this object field in the language, and sets the default locale.
|
void |
setLabelCurrentLanguageId(java.lang.String languageId) |
void |
setLabelMap(java.util.Map<java.util.Locale,java.lang.String> labelMap)
Sets the localized labels of this object field from the map of locales and localized labels.
|
void |
setLabelMap(java.util.Map<java.util.Locale,java.lang.String> labelMap,
java.util.Locale defaultLocale)
Sets the localized labels of this object field from the map of locales and localized labels, and sets the default locale.
|
void |
setListTypeDefinitionId(long listTypeDefinitionId)
Sets the list type definition ID of this object field.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Sets the modified date of this object field.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this object field.
|
void |
setName(java.lang.String name)
Sets the name of this object field.
|
void |
setObjectDefinitionId(long objectDefinitionId)
Sets the object definition ID of this object field.
|
void |
setObjectFieldId(long objectFieldId)
Sets the object field ID of this object field.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this object field.
|
void |
setRelationshipType(java.lang.String relationshipType)
Sets the relationship type of this object field.
|
void |
setRequired(boolean required)
Sets whether this object field is required.
|
void |
setUserId(long userId)
Sets the user ID of this object field.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this object field.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this object field.
|
void |
setUuid(java.lang.String uuid)
Sets the uuid of this object field.
|
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlString
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey
- the primary key of this object fieldlong getMvccVersion()
getMvccVersion
in interface com.liferay.portal.kernel.model.MVCCModel
void setMvccVersion(long mvccVersion)
setMvccVersion
in interface com.liferay.portal.kernel.model.MVCCModel
mvccVersion
- the mvcc version of this object field@AutoEscape java.lang.String getUuid()
getUuid
in interface com.liferay.portal.kernel.model.StagedModel
void setUuid(java.lang.String uuid)
setUuid
in interface com.liferay.portal.kernel.model.StagedModel
uuid
- the uuid of this object fieldlong getObjectFieldId()
void setObjectFieldId(long objectFieldId)
objectFieldId
- the object field ID of this object fieldlong getCompanyId()
getCompanyId
in interface com.liferay.portal.kernel.model.AuditedModel
getCompanyId
in interface com.liferay.portal.kernel.model.ShardedModel
getCompanyId
in interface com.liferay.portal.kernel.model.StagedModel
void setCompanyId(long companyId)
setCompanyId
in interface com.liferay.portal.kernel.model.AuditedModel
setCompanyId
in interface com.liferay.portal.kernel.model.ShardedModel
setCompanyId
in interface com.liferay.portal.kernel.model.StagedModel
companyId
- the company ID of this object fieldlong getUserId()
getUserId
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserId(long userId)
setUserId
in interface com.liferay.portal.kernel.model.AuditedModel
userId
- the user ID of this object fieldjava.lang.String getUserUuid()
getUserUuid
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserUuid(java.lang.String userUuid)
setUserUuid
in interface com.liferay.portal.kernel.model.AuditedModel
userUuid
- the user uuid of this object field@AutoEscape java.lang.String getUserName()
getUserName
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserName(java.lang.String userName)
setUserName
in interface com.liferay.portal.kernel.model.AuditedModel
userName
- the user name of this object fieldjava.util.Date getCreateDate()
getCreateDate
in interface com.liferay.portal.kernel.model.AuditedModel
getCreateDate
in interface com.liferay.portal.kernel.model.StagedModel
void setCreateDate(java.util.Date createDate)
setCreateDate
in interface com.liferay.portal.kernel.model.AuditedModel
setCreateDate
in interface com.liferay.portal.kernel.model.StagedModel
createDate
- the create date of this object fieldjava.util.Date getModifiedDate()
getModifiedDate
in interface com.liferay.portal.kernel.model.AuditedModel
getModifiedDate
in interface com.liferay.portal.kernel.model.StagedModel
void setModifiedDate(java.util.Date modifiedDate)
setModifiedDate
in interface com.liferay.portal.kernel.model.AuditedModel
setModifiedDate
in interface com.liferay.portal.kernel.model.StagedModel
modifiedDate
- the modified date of this object fieldlong getListTypeDefinitionId()
void setListTypeDefinitionId(long listTypeDefinitionId)
listTypeDefinitionId
- the list type definition ID of this object fieldlong getObjectDefinitionId()
void setObjectDefinitionId(long objectDefinitionId)
objectDefinitionId
- the object definition ID of this object field@AutoEscape java.lang.String getBusinessType()
void setBusinessType(java.lang.String businessType)
businessType
- the business type of this object field@AutoEscape java.lang.String getDBColumnName()
void setDBColumnName(java.lang.String dbColumnName)
dbColumnName
- the db column name of this object field@AutoEscape java.lang.String getDBTableName()
void setDBTableName(java.lang.String dbTableName)
dbTableName
- the db table name of this object field@AutoEscape java.lang.String getDBType()
void setDBType(java.lang.String dbType)
dbType
- the db type of this object fieldboolean getIndexed()
boolean isIndexed()
true
if this object field is indexed.true
if this object field is indexed; false
otherwisevoid setIndexed(boolean indexed)
indexed
- the indexed of this object fieldboolean getIndexedAsKeyword()
boolean isIndexedAsKeyword()
true
if this object field is indexed as keyword.true
if this object field is indexed as keyword; false
otherwisevoid setIndexedAsKeyword(boolean indexedAsKeyword)
indexedAsKeyword
- the indexed as keyword of this object field@AutoEscape java.lang.String getIndexedLanguageId()
void setIndexedLanguageId(java.lang.String indexedLanguageId)
indexedLanguageId
- the indexed language ID of this object fieldjava.lang.String getLabel()
@AutoEscape java.lang.String getLabel(java.util.Locale locale)
locale
- the locale of the language@AutoEscape java.lang.String getLabel(java.util.Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested languageuseDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getLabel(java.lang.String languageId)
languageId
- the ID of the language@AutoEscape java.lang.String getLabel(java.lang.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 java.lang.String getLabelCurrentLanguageId()
@AutoEscape java.lang.String getLabelCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getLabelMap()
void setLabel(java.lang.String label)
label
- the label of this object fieldvoid setLabel(java.lang.String label, java.util.Locale locale)
label
- the localized label of this object fieldlocale
- the locale of the languagevoid setLabel(java.lang.String label, java.util.Locale locale, java.util.Locale defaultLocale)
label
- the localized label of this object fieldlocale
- the locale of the languagedefaultLocale
- the default localevoid setLabelCurrentLanguageId(java.lang.String languageId)
void setLabelMap(java.util.Map<java.util.Locale,java.lang.String> labelMap)
labelMap
- the locales and localized labels of this object fieldvoid setLabelMap(java.util.Map<java.util.Locale,java.lang.String> labelMap, java.util.Locale defaultLocale)
labelMap
- the locales and localized labels of this object fielddefaultLocale
- the default locale@AutoEscape java.lang.String getName()
void setName(java.lang.String name)
name
- the name of this object field@AutoEscape java.lang.String getRelationshipType()
void setRelationshipType(java.lang.String relationshipType)
relationshipType
- the relationship type of this object fieldboolean getRequired()
boolean isRequired()
true
if this object field is required.true
if this object field is required; false
otherwisevoid setRequired(boolean required)
required
- the required of this object fieldjava.lang.String[] getAvailableLanguageIds()
getAvailableLanguageIds
in interface com.liferay.portal.kernel.model.LocalizedModel
java.lang.String getDefaultLanguageId()
getDefaultLanguageId
in interface com.liferay.portal.kernel.model.LocalizedModel
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport
in interface com.liferay.portal.kernel.model.LocalizedModel
com.liferay.portal.kernel.exception.LocaleException
void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport
in interface com.liferay.portal.kernel.model.LocalizedModel
com.liferay.portal.kernel.exception.LocaleException
ObjectField cloneWithOriginalValues()
cloneWithOriginalValues
in interface com.liferay.portal.kernel.model.BaseModel<ObjectField>