Package com.liferay.object.model
Interface ObjectFieldModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel,com.liferay.portal.kernel.model.BaseModel<ObjectField>,com.liferay.portal.kernel.model.ClassedModel,Cloneable,Comparable<ObjectField>,com.liferay.portal.kernel.model.ExternalReferenceCodeModel,com.liferay.portal.kernel.model.LocalizedModel,com.liferay.portal.kernel.model.MVCCModel,Serializable,com.liferay.portal.kernel.model.ShardedModel,com.liferay.portal.kernel.model.StagedAuditedModel,com.liferay.portal.kernel.model.StagedModel
- All Known Subinterfaces:
ObjectField
- All Known Implementing Classes:
ObjectFieldWrapper
@ProviderType
public interface ObjectFieldModel
extends com.liferay.portal.kernel.model.BaseModel<ObjectField>, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel
The base model interface for the ObjectField service. Represents a row in the "ObjectField" database table, with each column mapped to a property of this class.
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.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]Returns the business type of this object field.longReturns the company ID of this object field.Returns the create date of this object field.Returns the db column name of this object field.Returns the db table name of this object field.Returns the db type of this object field.Returns the external reference code of this object field.booleanReturns the indexed of this object field.booleanReturns the indexed as keyword of this object field.Returns the indexed language ID of this object field.getLabel()Returns the label of this object field.Returns the localized label of this object field in the language.Returns the localized label of this object field in the language, optionally using the default language if no localization exists for the requested language.Returns the localized label of this object field in the language.Returns the localized label of this object field in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized labels of this object field.longReturns the list type definition ID of this object field.booleanReturns the localized of this object field.Returns the modified date of this object field.longReturns the mvcc version of this object field.getName()Returns the name of this object field.longReturns the object definition ID of this object field.longReturns the object field ID of this object field.longReturns the primary key of this object field.Returns the read only of this object field.Returns the read only condition expression of this object field.Returns the relationship type of this object field.booleanReturns the required of this object field.booleangetState()Returns the state of this object field.booleanReturns the system of this object field.longReturns the user ID of this object field.Returns the user name of this object field.Returns the user uuid of this object field.getUuid()Returns the uuid of this object field.booleanReturnstrueif this object field is indexed.booleanReturnstrueif this object field is indexed as keyword.booleanReturnstrueif this object field is localized.booleanReturnstrueif this object field is required.booleanisState()Returnstrueif this object field is state.booleanisSystem()Returnstrueif this object field is system.voidvoidprepareLocalizedFieldsForImport(Locale defaultImportLocale) voidsetBusinessType(String businessType) Sets the business type of this object field.voidsetCompanyId(long companyId) Sets the company ID of this object field.voidsetCreateDate(Date createDate) Sets the create date of this object field.voidsetDBColumnName(String dbColumnName) Sets the db column name of this object field.voidsetDBTableName(String dbTableName) Sets the db table name of this object field.voidSets the db type of this object field.voidsetExternalReferenceCode(String externalReferenceCode) Sets the external reference code of this object field.voidsetIndexed(boolean indexed) Sets whether this object field is indexed.voidsetIndexedAsKeyword(boolean indexedAsKeyword) Sets whether this object field is indexed as keyword.voidsetIndexedLanguageId(String indexedLanguageId) Sets the indexed language ID of this object field.voidSets the label of this object field.voidSets the localized label of this object field in the language.voidSets the localized label of this object field in the language, and sets the default locale.voidsetLabelCurrentLanguageId(String languageId) voidsetLabelMap(Map<Locale, String> labelMap) Sets the localized labels of this object field from the map of locales and localized labels.voidsetLabelMap(Map<Locale, String> labelMap, Locale defaultLocale) Sets the localized labels of this object field from the map of locales and localized labels, and sets the default locale.voidsetListTypeDefinitionId(long listTypeDefinitionId) Sets the list type definition ID of this object field.voidsetLocalized(boolean localized) Sets whether this object field is localized.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this object field.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this object field.voidSets the name of this object field.voidsetObjectDefinitionId(long objectDefinitionId) Sets the object definition ID of this object field.voidsetObjectFieldId(long objectFieldId) Sets the object field ID of this object field.voidsetPrimaryKey(long primaryKey) Sets the primary key of this object field.voidsetReadOnly(String readOnly) Sets the read only of this object field.voidsetReadOnlyConditionExpression(String readOnlyConditionExpression) Sets the read only condition expression of this object field.voidsetRelationshipType(String relationshipType) Sets the relationship type of this object field.voidsetRequired(boolean required) Sets whether this object field is required.voidsetState(boolean state) Sets whether this object field is state.voidsetSystem(boolean system) Sets whether this object field is system.voidsetUserId(long userId) Sets the user ID of this object field.voidsetUserName(String userName) Sets the user name of this object field.voidsetUserUuid(String userUuid) Sets the user uuid of this object field.voidSets the uuid of this object field.default StringMethods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this object field.- Returns:
- the primary key of this object field
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this object field.- Parameters:
primaryKey- the primary key of this object field
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this object field.- Specified by:
getMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Returns:
- the mvcc version of this object field
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this object field.- Specified by:
setMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Parameters:
mvccVersion- the mvcc version of this object field
-
getUuid
Returns the uuid of this object field.- Specified by:
getUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the uuid of this object field
-
setUuid
Sets the uuid of this object field.- Specified by:
setUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
uuid- the uuid of this object field
-
getExternalReferenceCode
Returns the external reference code of this object field.- Specified by:
getExternalReferenceCodein interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel- Returns:
- the external reference code of this object field
-
setExternalReferenceCode
Sets the external reference code of this object field.- Specified by:
setExternalReferenceCodein interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel- Parameters:
externalReferenceCode- the external reference code of this object field
-
getObjectFieldId
long getObjectFieldId()Returns the object field ID of this object field.- Returns:
- the object field ID of this object field
-
setObjectFieldId
void setObjectFieldId(long objectFieldId) Sets the object field ID of this object field.- Parameters:
objectFieldId- the object field ID of this object field
-
getCompanyId
long getCompanyId()Returns the company ID of this object field.- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.ShardedModel- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the company ID of this object field
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this object field.- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.ShardedModel- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
companyId- the company ID of this object field
-
getUserId
long getUserId()Returns the user ID of this object field.- Specified by:
getUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user ID of this object field
-
setUserId
void setUserId(long userId) Sets the user ID of this object field.- Specified by:
setUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userId- the user ID of this object field
-
getUserUuid
String getUserUuid()Returns the user uuid of this object field.- Specified by:
getUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user uuid of this object field
-
setUserUuid
Sets the user uuid of this object field.- Specified by:
setUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userUuid- the user uuid of this object field
-
getUserName
Returns the user name of this object field.- Specified by:
getUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user name of this object field
-
setUserName
Sets the user name of this object field.- Specified by:
setUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userName- the user name of this object field
-
getCreateDate
Date getCreateDate()Returns the create date of this object field.- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the create date of this object field
-
setCreateDate
Sets the create date of this object field.- Specified by:
setCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setCreateDatein interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
createDate- the create date of this object field
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this object field.- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the modified date of this object field
-
setModifiedDate
Sets the modified date of this object field.- Specified by:
setModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setModifiedDatein interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
modifiedDate- the modified date of this object field
-
getListTypeDefinitionId
long getListTypeDefinitionId()Returns the list type definition ID of this object field.- Returns:
- the list type definition ID of this object field
-
setListTypeDefinitionId
void setListTypeDefinitionId(long listTypeDefinitionId) Sets the list type definition ID of this object field.- Parameters:
listTypeDefinitionId- the list type definition ID of this object field
-
getObjectDefinitionId
long getObjectDefinitionId()Returns the object definition ID of this object field.- Returns:
- the object definition ID of this object field
-
setObjectDefinitionId
void setObjectDefinitionId(long objectDefinitionId) Sets the object definition ID of this object field.- Parameters:
objectDefinitionId- the object definition ID of this object field
-
getBusinessType
Returns the business type of this object field.- Returns:
- the business type of this object field
-
setBusinessType
Sets the business type of this object field.- Parameters:
businessType- the business type of this object field
-
getDBColumnName
Returns the db column name of this object field.- Returns:
- the db column name of this object field
-
setDBColumnName
Sets the db column name of this object field.- Parameters:
dbColumnName- the db column name of this object field
-
getDBTableName
Returns the db table name of this object field.- Returns:
- the db table name of this object field
-
setDBTableName
Sets the db table name of this object field.- Parameters:
dbTableName- the db table name of this object field
-
getDBType
Returns the db type of this object field.- Returns:
- the db type of this object field
-
setDBType
Sets the db type of this object field.- Parameters:
dbType- the db type of this object field
-
getIndexed
boolean getIndexed()Returns the indexed of this object field.- Returns:
- the indexed of this object field
-
isIndexed
boolean isIndexed()Returnstrueif this object field is indexed.- Returns:
trueif this object field is indexed;falseotherwise
-
setIndexed
void setIndexed(boolean indexed) Sets whether this object field is indexed.- Parameters:
indexed- the indexed of this object field
-
getIndexedAsKeyword
boolean getIndexedAsKeyword()Returns the indexed as keyword of this object field.- Returns:
- the indexed as keyword of this object field
-
isIndexedAsKeyword
boolean isIndexedAsKeyword()Returnstrueif this object field is indexed as keyword.- Returns:
trueif this object field is indexed as keyword;falseotherwise
-
setIndexedAsKeyword
void setIndexedAsKeyword(boolean indexedAsKeyword) Sets whether this object field is indexed as keyword.- Parameters:
indexedAsKeyword- the indexed as keyword of this object field
-
getIndexedLanguageId
Returns the indexed language ID of this object field.- Returns:
- the indexed language ID of this object field
-
setIndexedLanguageId
Sets the indexed language ID of this object field.- Parameters:
indexedLanguageId- the indexed language ID of this object field
-
getLabel
String getLabel()Returns the label of this object field.- Returns:
- the label of this object field
-
getLabel
Returns the localized label of this object field 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 label of this object field
-
getLabel
Returns the localized label of this object field in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
locale- the local of the languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized label of this object field. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getLabel
Returns the localized label of this object field 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 label of this object field
-
getLabel
Returns the localized label of this object field in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId- the ID of the languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized label of this object field
-
getLabelCurrentLanguageId
-
getLabelCurrentValue
-
getLabelMap
Returns a map of the locales and localized labels of this object field.- Returns:
- the locales and localized labels of this object field
-
setLabel
Sets the label of this object field.- Parameters:
label- the label of this object field
-
setLabel
Sets the localized label of this object field in the language.- Parameters:
label- the localized label of this object fieldlocale- the locale of the language
-
setLabel
Sets the localized label of this object field in the language, and sets the default locale.- Parameters:
label- the localized label of this object fieldlocale- the locale of the languagedefaultLocale- the default locale
-
setLabelCurrentLanguageId
-
setLabelMap
Sets the localized labels of this object field from the map of locales and localized labels.- Parameters:
labelMap- the locales and localized labels of this object field
-
setLabelMap
Sets the localized labels of this object field from the map of locales and localized labels, and sets the default locale.- Parameters:
labelMap- the locales and localized labels of this object fielddefaultLocale- the default locale
-
getLocalized
boolean getLocalized()Returns the localized of this object field.- Returns:
- the localized of this object field
-
isLocalized
boolean isLocalized()Returnstrueif this object field is localized.- Returns:
trueif this object field is localized;falseotherwise
-
setLocalized
void setLocalized(boolean localized) Sets whether this object field is localized.- Parameters:
localized- the localized of this object field
-
getName
Returns the name of this object field.- Returns:
- the name of this object field
-
setName
Sets the name of this object field.- Parameters:
name- the name of this object field
-
getReadOnly
Returns the read only of this object field.- Returns:
- the read only of this object field
-
setReadOnly
Sets the read only of this object field.- Parameters:
readOnly- the read only of this object field
-
getReadOnlyConditionExpression
Returns the read only condition expression of this object field.- Returns:
- the read only condition expression of this object field
-
setReadOnlyConditionExpression
Sets the read only condition expression of this object field.- Parameters:
readOnlyConditionExpression- the read only condition expression of this object field
-
getRelationshipType
Returns the relationship type of this object field.- Returns:
- the relationship type of this object field
-
setRelationshipType
Sets the relationship type of this object field.- Parameters:
relationshipType- the relationship type of this object field
-
getRequired
boolean getRequired()Returns the required of this object field.- Returns:
- the required of this object field
-
isRequired
boolean isRequired()Returnstrueif this object field is required.- Returns:
trueif this object field is required;falseotherwise
-
setRequired
void setRequired(boolean required) Sets whether this object field is required.- Parameters:
required- the required of this object field
-
getState
boolean getState()Returns the state of this object field.- Returns:
- the state of this object field
-
isState
boolean isState()Returnstrueif this object field is state.- Returns:
trueif this object field is state;falseotherwise
-
setState
void setState(boolean state) Sets whether this object field is state.- Parameters:
state- the state of this object field
-
getSystem
boolean getSystem()Returns the system of this object field.- Returns:
- the system of this object field
-
isSystem
boolean isSystem()Returnstrueif this object field is system.- Returns:
trueif this object field is system;falseotherwise
-
setSystem
void setSystem(boolean system) Sets whether this object field is system.- Parameters:
system- the system of this object field
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIdsin interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageIdin interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImportin interfacecom.liferay.portal.kernel.model.LocalizedModel- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException - Specified by:
prepareLocalizedFieldsForImportin interfacecom.liferay.portal.kernel.model.LocalizedModel- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
ObjectField cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfacecom.liferay.portal.kernel.model.BaseModel<ObjectField>
-
toXmlString
-