Class ObjectFieldWrapper

java.lang.Object
com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<ObjectField>
com.liferay.object.model.ObjectFieldWrapper
All Implemented Interfaces:
ObjectField, ObjectFieldModel, com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<ObjectField>, com.liferay.portal.kernel.model.ClassedModel, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.ModelWrapper<ObjectField>, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.PersistedModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel, com.liferay.portal.kernel.model.StagedModel, Serializable, Cloneable, Comparable<ObjectField>

public class ObjectFieldWrapper extends com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<ObjectField> implements com.liferay.portal.kernel.model.ModelWrapper<ObjectField>, ObjectField

This class is a wrapper for ObjectField.

See Also:
Generated:
  • Constructor Details

    • ObjectFieldWrapper

      public ObjectFieldWrapper(ObjectField objectField)
  • Method Details

    • getModelAttributes

      public Map<String,Object> getModelAttributes()
      Specified by:
      getModelAttributes in interface com.liferay.portal.kernel.model.BaseModel<ObjectField>
    • setModelAttributes

      public void setModelAttributes(Map<String,Object> attributes)
      Specified by:
      setModelAttributes in interface com.liferay.portal.kernel.model.BaseModel<ObjectField>
    • cloneWithOriginalValues

      public ObjectField cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface com.liferay.portal.kernel.model.BaseModel<ObjectField>
      Specified by:
      cloneWithOriginalValues in interface ObjectFieldModel
    • compareBusinessType

      public boolean compareBusinessType(String businessType)
      Specified by:
      compareBusinessType in interface ObjectField
    • getAvailableLanguageIds

      public String[] getAvailableLanguageIds()
      Specified by:
      getAvailableLanguageIds in interface com.liferay.portal.kernel.model.LocalizedModel
      Specified by:
      getAvailableLanguageIds in interface ObjectFieldModel
    • getBusinessType

      public String getBusinessType()
      Returns the business type of this object field.
      Specified by:
      getBusinessType in interface ObjectFieldModel
      Returns:
      the business type of this object field
    • getCompanyId

      public long getCompanyId()
      Returns the company ID of this object field.
      Specified by:
      getCompanyId in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getCompanyId in interface ObjectFieldModel
      Specified by:
      getCompanyId in interface com.liferay.portal.kernel.model.ShardedModel
      Specified by:
      getCompanyId in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the company ID of this object field
    • getCreateDate

      public Date getCreateDate()
      Returns the create date of this object field.
      Specified by:
      getCreateDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getCreateDate in interface ObjectFieldModel
      Specified by:
      getCreateDate in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the create date of this object field
    • getDBColumnName

      public String getDBColumnName()
      Returns the db column name of this object field.
      Specified by:
      getDBColumnName in interface ObjectFieldModel
      Returns:
      the db column name of this object field
    • getDBTableName

      public String getDBTableName()
      Returns the db table name of this object field.
      Specified by:
      getDBTableName in interface ObjectFieldModel
      Returns:
      the db table name of this object field
    • getDBType

      public String getDBType()
      Returns the db type of this object field.
      Specified by:
      getDBType in interface ObjectFieldModel
      Returns:
      the db type of this object field
    • getDefaultLanguageId

      public String getDefaultLanguageId()
      Specified by:
      getDefaultLanguageId in interface com.liferay.portal.kernel.model.LocalizedModel
      Specified by:
      getDefaultLanguageId in interface ObjectFieldModel
    • getExternalReferenceCode

      public String getExternalReferenceCode()
      Returns the external reference code of this object field.
      Specified by:
      getExternalReferenceCode in interface com.liferay.portal.kernel.model.ExternalReferenceCodeModel
      Specified by:
      getExternalReferenceCode in interface ObjectFieldModel
      Returns:
      the external reference code of this object field
    • getI18nObjectFieldName

      public String getI18nObjectFieldName()
      Specified by:
      getI18nObjectFieldName in interface ObjectField
    • getIndexed

      public boolean getIndexed()
      Returns the indexed of this object field.
      Specified by:
      getIndexed in interface ObjectFieldModel
      Returns:
      the indexed of this object field
    • getIndexedAsKeyword

      public boolean getIndexedAsKeyword()
      Returns the indexed as keyword of this object field.
      Specified by:
      getIndexedAsKeyword in interface ObjectFieldModel
      Returns:
      the indexed as keyword of this object field
    • getIndexedLanguageId

      public String getIndexedLanguageId()
      Returns the indexed language ID of this object field.
      Specified by:
      getIndexedLanguageId in interface ObjectFieldModel
      Returns:
      the indexed language ID of this object field
    • getLabel

      public String getLabel()
      Returns the label of this object field.
      Specified by:
      getLabel in interface ObjectFieldModel
      Returns:
      the label of this object field
    • getLabel

      public String getLabel(Locale locale)
      Returns the localized label of this object field in the language. Uses the default language if no localization exists for the requested language.
      Specified by:
      getLabel in interface ObjectFieldModel
      Parameters:
      locale - the locale of the language
      Returns:
      the localized label of this object field
    • getLabel

      public String getLabel(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.
      Specified by:
      getLabel in interface ObjectFieldModel
      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 label of this object field. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getLabel

      public String getLabel(String languageId)
      Returns the localized label of this object field in the language. Uses the default language if no localization exists for the requested language.
      Specified by:
      getLabel in interface ObjectFieldModel
      Parameters:
      languageId - the ID of the language
      Returns:
      the localized label of this object field
    • getLabel

      public String getLabel(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.
      Specified by:
      getLabel in interface ObjectFieldModel
      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 label of this object field
    • getLabelCurrentLanguageId

      public String getLabelCurrentLanguageId()
      Specified by:
      getLabelCurrentLanguageId in interface ObjectFieldModel
    • getLabelCurrentValue

      public String getLabelCurrentValue()
      Specified by:
      getLabelCurrentValue in interface ObjectFieldModel
    • getLabelMap

      public Map<Locale,String> getLabelMap()
      Returns a map of the locales and localized labels of this object field.
      Specified by:
      getLabelMap in interface ObjectFieldModel
      Returns:
      the locales and localized labels of this object field
    • getListTypeDefinitionId

      public long getListTypeDefinitionId()
      Returns the list type definition ID of this object field.
      Specified by:
      getListTypeDefinitionId in interface ObjectFieldModel
      Returns:
      the list type definition ID of this object field
    • getLocalized

      public boolean getLocalized()
      Returns the localized of this object field.
      Specified by:
      getLocalized in interface ObjectFieldModel
      Returns:
      the localized of this object field
    • getModifiedDate

      public Date getModifiedDate()
      Returns the modified date of this object field.
      Specified by:
      getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getModifiedDate in interface ObjectFieldModel
      Specified by:
      getModifiedDate in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the modified date of this object field
    • getMvccVersion

      public long getMvccVersion()
      Returns the mvcc version of this object field.
      Specified by:
      getMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Specified by:
      getMvccVersion in interface ObjectFieldModel
      Returns:
      the mvcc version of this object field
    • getName

      public String getName()
      Returns the name of this object field.
      Specified by:
      getName in interface ObjectFieldModel
      Returns:
      the name of this object field
    • getObjectDefinition

      public ObjectDefinition getObjectDefinition() throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getObjectDefinition in interface ObjectField
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectDefinitionId

      public long getObjectDefinitionId()
      Returns the object definition ID of this object field.
      Specified by:
      getObjectDefinitionId in interface ObjectFieldModel
      Returns:
      the object definition ID of this object field
    • getObjectFieldId

      public long getObjectFieldId()
      Returns the object field ID of this object field.
      Specified by:
      getObjectFieldId in interface ObjectFieldModel
      Returns:
      the object field ID of this object field
    • getObjectFieldSettings

      public List<ObjectFieldSetting> getObjectFieldSettings()
      Specified by:
      getObjectFieldSettings in interface ObjectField
    • getPrimaryKey

      public long getPrimaryKey()
      Returns the primary key of this object field.
      Specified by:
      getPrimaryKey in interface ObjectFieldModel
      Returns:
      the primary key of this object field
    • getReadOnly

      public String getReadOnly()
      Returns the read only of this object field.
      Specified by:
      getReadOnly in interface ObjectFieldModel
      Returns:
      the read only of this object field
    • getReadOnlyConditionExpression

      public String getReadOnlyConditionExpression()
      Returns the read only condition expression of this object field.
      Specified by:
      getReadOnlyConditionExpression in interface ObjectFieldModel
      Returns:
      the read only condition expression of this object field
    • getRelationshipType

      public String getRelationshipType()
      Returns the relationship type of this object field.
      Specified by:
      getRelationshipType in interface ObjectFieldModel
      Returns:
      the relationship type of this object field
    • getRequired

      public boolean getRequired()
      Returns the required of this object field.
      Specified by:
      getRequired in interface ObjectFieldModel
      Returns:
      the required of this object field
    • getSortableDBColumnName

      public String getSortableDBColumnName()
      Specified by:
      getSortableDBColumnName in interface ObjectField
    • getState

      public boolean getState()
      Returns the state of this object field.
      Specified by:
      getState in interface ObjectFieldModel
      Returns:
      the state of this object field
    • getSystem

      public boolean getSystem()
      Returns the system of this object field.
      Specified by:
      getSystem in interface ObjectFieldModel
      Returns:
      the system of this object field
    • getUserId

      public long getUserId()
      Returns the user ID of this object field.
      Specified by:
      getUserId in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getUserId in interface ObjectFieldModel
      Returns:
      the user ID of this object field
    • getUserName

      public String getUserName()
      Returns the user name of this object field.
      Specified by:
      getUserName in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getUserName in interface ObjectFieldModel
      Returns:
      the user name of this object field
    • getUserUuid

      public String getUserUuid()
      Returns the user uuid of this object field.
      Specified by:
      getUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getUserUuid in interface ObjectFieldModel
      Returns:
      the user uuid of this object field
    • getUuid

      public String getUuid()
      Returns the uuid of this object field.
      Specified by:
      getUuid in interface ObjectFieldModel
      Specified by:
      getUuid in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the uuid of this object field
    • hasInsertValues

      public boolean hasInsertValues()
      Specified by:
      hasInsertValues in interface ObjectField
    • hasUniqueValues

      public boolean hasUniqueValues()
      Specified by:
      hasUniqueValues in interface ObjectField
    • hasUpdateValues

      public boolean hasUpdateValues()
      Specified by:
      hasUpdateValues in interface ObjectField
    • isDeletionAllowed

      public boolean isDeletionAllowed() throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      isDeletionAllowed in interface ObjectField
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • isIndexed

      public boolean isIndexed()
      Returns true if this object field is indexed.
      Specified by:
      isIndexed in interface ObjectFieldModel
      Returns:
      true if this object field is indexed; false otherwise
    • isIndexedAsKeyword

      public boolean isIndexedAsKeyword()
      Returns true if this object field is indexed as keyword.
      Specified by:
      isIndexedAsKeyword in interface ObjectFieldModel
      Returns:
      true if this object field is indexed as keyword; false otherwise
    • isLocalized

      public boolean isLocalized()
      Returns true if this object field is localized.
      Specified by:
      isLocalized in interface ObjectFieldModel
      Returns:
      true if this object field is localized; false otherwise
    • isMetadata

      public boolean isMetadata()
      Specified by:
      isMetadata in interface ObjectField
    • isRequired

      public boolean isRequired()
      Returns true if this object field is required.
      Specified by:
      isRequired in interface ObjectFieldModel
      Returns:
      true if this object field is required; false otherwise
    • isState

      public boolean isState()
      Returns true if this object field is state.
      Specified by:
      isState in interface ObjectFieldModel
      Returns:
      true if this object field is state; false otherwise
    • isSystem

      public boolean isSystem()
      Returns true if this object field is system.
      Specified by:
      isSystem in interface ObjectFieldModel
      Returns:
      true if this object field is system; false otherwise
    • persist

      public void persist()
      Specified by:
      persist in interface com.liferay.portal.kernel.model.PersistedModel
    • prepareLocalizedFieldsForImport

      public void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModel
      Specified by:
      prepareLocalizedFieldsForImport in interface ObjectFieldModel
      Throws:
      com.liferay.portal.kernel.exception.LocaleException
    • prepareLocalizedFieldsForImport

      public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModel
      Specified by:
      prepareLocalizedFieldsForImport in interface ObjectFieldModel
      Throws:
      com.liferay.portal.kernel.exception.LocaleException
    • setBusinessType

      public void setBusinessType(String businessType)
      Sets the business type of this object field.
      Specified by:
      setBusinessType in interface ObjectFieldModel
      Parameters:
      businessType - the business type of this object field
    • setCompanyId

      public void setCompanyId(long companyId)
      Sets the company ID of this object field.
      Specified by:
      setCompanyId in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setCompanyId in interface ObjectFieldModel
      Specified by:
      setCompanyId in interface com.liferay.portal.kernel.model.ShardedModel
      Specified by:
      setCompanyId in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      companyId - the company ID of this object field
    • setCreateDate

      public void setCreateDate(Date createDate)
      Sets the create date of this object field.
      Specified by:
      setCreateDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setCreateDate in interface ObjectFieldModel
      Specified by:
      setCreateDate in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      createDate - the create date of this object field
    • setDBColumnName

      public void setDBColumnName(String dbColumnName)
      Sets the db column name of this object field.
      Specified by:
      setDBColumnName in interface ObjectFieldModel
      Parameters:
      dbColumnName - the db column name of this object field
    • setDBTableName

      public void setDBTableName(String dbTableName)
      Sets the db table name of this object field.
      Specified by:
      setDBTableName in interface ObjectFieldModel
      Parameters:
      dbTableName - the db table name of this object field
    • setDBType

      public void setDBType(String dbType)
      Sets the db type of this object field.
      Specified by:
      setDBType in interface ObjectFieldModel
      Parameters:
      dbType - the db type of this object field
    • setExternalReferenceCode

      public void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this object field.
      Specified by:
      setExternalReferenceCode in interface com.liferay.portal.kernel.model.ExternalReferenceCodeModel
      Specified by:
      setExternalReferenceCode in interface ObjectFieldModel
      Parameters:
      externalReferenceCode - the external reference code of this object field
    • setIndexed

      public void setIndexed(boolean indexed)
      Sets whether this object field is indexed.
      Specified by:
      setIndexed in interface ObjectFieldModel
      Parameters:
      indexed - the indexed of this object field
    • setIndexedAsKeyword

      public void setIndexedAsKeyword(boolean indexedAsKeyword)
      Sets whether this object field is indexed as keyword.
      Specified by:
      setIndexedAsKeyword in interface ObjectFieldModel
      Parameters:
      indexedAsKeyword - the indexed as keyword of this object field
    • setIndexedLanguageId

      public void setIndexedLanguageId(String indexedLanguageId)
      Sets the indexed language ID of this object field.
      Specified by:
      setIndexedLanguageId in interface ObjectFieldModel
      Parameters:
      indexedLanguageId - the indexed language ID of this object field
    • setLabel

      public void setLabel(String label)
      Sets the label of this object field.
      Specified by:
      setLabel in interface ObjectFieldModel
      Parameters:
      label - the label of this object field
    • setLabel

      public void setLabel(String label, Locale locale)
      Sets the localized label of this object field in the language.
      Specified by:
      setLabel in interface ObjectFieldModel
      Parameters:
      label - the localized label of this object field
      locale - the locale of the language
    • setLabel

      public void setLabel(String label, Locale locale, Locale defaultLocale)
      Sets the localized label of this object field in the language, and sets the default locale.
      Specified by:
      setLabel in interface ObjectFieldModel
      Parameters:
      label - the localized label of this object field
      locale - the locale of the language
      defaultLocale - the default locale
    • setLabelCurrentLanguageId

      public void setLabelCurrentLanguageId(String languageId)
      Specified by:
      setLabelCurrentLanguageId in interface ObjectFieldModel
    • setLabelMap

      public void setLabelMap(Map<Locale,String> labelMap)
      Sets the localized labels of this object field from the map of locales and localized labels.
      Specified by:
      setLabelMap in interface ObjectFieldModel
      Parameters:
      labelMap - the locales and localized labels of this object field
    • setLabelMap

      public void setLabelMap(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.
      Specified by:
      setLabelMap in interface ObjectFieldModel
      Parameters:
      labelMap - the locales and localized labels of this object field
      defaultLocale - the default locale
    • setListTypeDefinitionId

      public void setListTypeDefinitionId(long listTypeDefinitionId)
      Sets the list type definition ID of this object field.
      Specified by:
      setListTypeDefinitionId in interface ObjectFieldModel
      Parameters:
      listTypeDefinitionId - the list type definition ID of this object field
    • setLocalized

      public void setLocalized(boolean localized)
      Sets whether this object field is localized.
      Specified by:
      setLocalized in interface ObjectFieldModel
      Parameters:
      localized - the localized of this object field
    • setModifiedDate

      public void setModifiedDate(Date modifiedDate)
      Sets the modified date of this object field.
      Specified by:
      setModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setModifiedDate in interface ObjectFieldModel
      Specified by:
      setModifiedDate in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      modifiedDate - the modified date of this object field
    • setMvccVersion

      public void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this object field.
      Specified by:
      setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Specified by:
      setMvccVersion in interface ObjectFieldModel
      Parameters:
      mvccVersion - the mvcc version of this object field
    • setName

      public void setName(String name)
      Sets the name of this object field.
      Specified by:
      setName in interface ObjectFieldModel
      Parameters:
      name - the name of this object field
    • setObjectDefinitionId

      public void setObjectDefinitionId(long objectDefinitionId)
      Sets the object definition ID of this object field.
      Specified by:
      setObjectDefinitionId in interface ObjectFieldModel
      Parameters:
      objectDefinitionId - the object definition ID of this object field
    • setObjectFieldId

      public void setObjectFieldId(long objectFieldId)
      Sets the object field ID of this object field.
      Specified by:
      setObjectFieldId in interface ObjectFieldModel
      Parameters:
      objectFieldId - the object field ID of this object field
    • setObjectFieldSettings

      public void setObjectFieldSettings(List<ObjectFieldSetting> objectFieldSettings)
      Specified by:
      setObjectFieldSettings in interface ObjectField
    • setPrimaryKey

      public void setPrimaryKey(long primaryKey)
      Sets the primary key of this object field.
      Specified by:
      setPrimaryKey in interface ObjectFieldModel
      Parameters:
      primaryKey - the primary key of this object field
    • setReadOnly

      public void setReadOnly(String readOnly)
      Sets the read only of this object field.
      Specified by:
      setReadOnly in interface ObjectFieldModel
      Parameters:
      readOnly - the read only of this object field
    • setReadOnlyConditionExpression

      public void setReadOnlyConditionExpression(String readOnlyConditionExpression)
      Sets the read only condition expression of this object field.
      Specified by:
      setReadOnlyConditionExpression in interface ObjectFieldModel
      Parameters:
      readOnlyConditionExpression - the read only condition expression of this object field
    • setRelationshipType

      public void setRelationshipType(String relationshipType)
      Sets the relationship type of this object field.
      Specified by:
      setRelationshipType in interface ObjectFieldModel
      Parameters:
      relationshipType - the relationship type of this object field
    • setRequired

      public void setRequired(boolean required)
      Sets whether this object field is required.
      Specified by:
      setRequired in interface ObjectFieldModel
      Parameters:
      required - the required of this object field
    • setState

      public void setState(boolean state)
      Sets whether this object field is state.
      Specified by:
      setState in interface ObjectFieldModel
      Parameters:
      state - the state of this object field
    • setSystem

      public void setSystem(boolean system)
      Sets whether this object field is system.
      Specified by:
      setSystem in interface ObjectFieldModel
      Parameters:
      system - the system of this object field
    • setUserId

      public void setUserId(long userId)
      Sets the user ID of this object field.
      Specified by:
      setUserId in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setUserId in interface ObjectFieldModel
      Parameters:
      userId - the user ID of this object field
    • setUserName

      public void setUserName(String userName)
      Sets the user name of this object field.
      Specified by:
      setUserName in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setUserName in interface ObjectFieldModel
      Parameters:
      userName - the user name of this object field
    • setUserUuid

      public void setUserUuid(String userUuid)
      Sets the user uuid of this object field.
      Specified by:
      setUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setUserUuid in interface ObjectFieldModel
      Parameters:
      userUuid - the user uuid of this object field
    • setUuid

      public void setUuid(String uuid)
      Sets the uuid of this object field.
      Specified by:
      setUuid in interface ObjectFieldModel
      Specified by:
      setUuid in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      uuid - the uuid of this object field
    • toXmlString

      public String toXmlString()
      Specified by:
      toXmlString in interface ObjectFieldModel
    • getStagedModelType

      public com.liferay.exportimport.kernel.lar.StagedModelType getStagedModelType()
      Specified by:
      getStagedModelType in interface com.liferay.portal.kernel.model.StagedModel
    • wrap

      protected ObjectFieldWrapper wrap(ObjectField objectField)
      Specified by:
      wrap in class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<ObjectField>