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 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:
      getMvccVersion in interface com.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:
      setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this object field
    • getUuid

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

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

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

      void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this object field.
      Specified by:
      setExternalReferenceCode in interface com.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:
      getCompanyId in interface com.liferay.portal.kernel.model.AuditedModel
      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
    • setCompanyId

      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 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
    • getUserId

      long getUserId()
      Returns the user ID of this object field.
      Specified by:
      getUserId in interface com.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:
      setUserId in interface com.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:
      getUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user uuid of this object field
    • setUserUuid

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

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

      void setUserName(String userName)
      Sets the user name of this object field.
      Specified by:
      setUserName in interface com.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:
      getCreateDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getCreateDate in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the create date of this object field
    • setCreateDate

      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 com.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:
      getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getModifiedDate in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the modified date of this object field
    • setModifiedDate

      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 com.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

      @AutoEscape String getBusinessType()
      Returns the business type of this object field.
      Returns:
      the business type of this object field
    • setBusinessType

      void setBusinessType(String businessType)
      Sets the business type of this object field.
      Parameters:
      businessType - the business type of this object field
    • getDBColumnName

      @AutoEscape String getDBColumnName()
      Returns the db column name of this object field.
      Returns:
      the db column name of this object field
    • setDBColumnName

      void setDBColumnName(String dbColumnName)
      Sets the db column name of this object field.
      Parameters:
      dbColumnName - the db column name of this object field
    • getDBTableName

      @AutoEscape String getDBTableName()
      Returns the db table name of this object field.
      Returns:
      the db table name of this object field
    • setDBTableName

      void setDBTableName(String dbTableName)
      Sets the db table name of this object field.
      Parameters:
      dbTableName - the db table name of this object field
    • getDBType

      @AutoEscape String getDBType()
      Returns the db type of this object field.
      Returns:
      the db type of this object field
    • setDBType

      void setDBType(String dbType)
      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()
      Returns true if this object field is indexed.
      Returns:
      true if this object field is indexed; false otherwise
    • 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()
      Returns true if this object field is indexed as keyword.
      Returns:
      true if this object field is indexed as keyword; false otherwise
    • 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

      @AutoEscape String getIndexedLanguageId()
      Returns the indexed language ID of this object field.
      Returns:
      the indexed language ID of this object field
    • setIndexedLanguageId

      void setIndexedLanguageId(String indexedLanguageId)
      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

      @AutoEscape 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.
      Parameters:
      locale - the locale of the language
      Returns:
      the localized label of this object field
    • getLabel

      @AutoEscape 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.
      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

      @AutoEscape 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.
      Parameters:
      languageId - the ID of the language
      Returns:
      the localized label of this object field
    • getLabel

      @AutoEscape 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.
      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

      @AutoEscape String getLabelCurrentLanguageId()
    • getLabelCurrentValue

      @AutoEscape String getLabelCurrentValue()
    • getLabelMap

      Map<Locale,String> 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

      void setLabel(String label)
      Sets the label of this object field.
      Parameters:
      label - the label of this object field
    • setLabel

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

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

      void setLabelCurrentLanguageId(String languageId)
    • setLabelMap

      void setLabelMap(Map<Locale,String> labelMap)
      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

      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.
      Parameters:
      labelMap - the locales and localized labels of this object field
      defaultLocale - the default locale
    • getLocalized

      boolean getLocalized()
      Returns the localized of this object field.
      Returns:
      the localized of this object field
    • isLocalized

      boolean isLocalized()
      Returns true if this object field is localized.
      Returns:
      true if this object field is localized; false otherwise
    • setLocalized

      void setLocalized(boolean localized)
      Sets whether this object field is localized.
      Parameters:
      localized - the localized of this object field
    • getName

      @AutoEscape String getName()
      Returns the name of this object field.
      Returns:
      the name of this object field
    • setName

      void setName(String name)
      Sets the name of this object field.
      Parameters:
      name - the name of this object field
    • getReadOnly

      @AutoEscape String getReadOnly()
      Returns the read only of this object field.
      Returns:
      the read only of this object field
    • setReadOnly

      void setReadOnly(String readOnly)
      Sets the read only of this object field.
      Parameters:
      readOnly - the read only of this object field
    • getReadOnlyConditionExpression

      @AutoEscape String getReadOnlyConditionExpression()
      Returns the read only condition expression of this object field.
      Returns:
      the read only condition expression of this object field
    • setReadOnlyConditionExpression

      void setReadOnlyConditionExpression(String readOnlyConditionExpression)
      Sets the read only condition expression of this object field.
      Parameters:
      readOnlyConditionExpression - the read only condition expression of this object field
    • getRelationshipType

      @AutoEscape String getRelationshipType()
      Returns the relationship type of this object field.
      Returns:
      the relationship type of this object field
    • setRelationshipType

      void setRelationshipType(String relationshipType)
      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()
      Returns true if this object field is required.
      Returns:
      true if this object field is required; false otherwise
    • 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()
      Returns true if this object field is state.
      Returns:
      true if this object field is state; false otherwise
    • 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()
      Returns true if this object field is system.
      Returns:
      true if this object field is system; false otherwise
    • 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:
      getAvailableLanguageIds in interface com.liferay.portal.kernel.model.LocalizedModel
    • getDefaultLanguageId

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

      void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface com.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:
      prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModel
      Throws:
      com.liferay.portal.kernel.exception.LocaleException
    • cloneWithOriginalValues

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

      default String toXmlString()