Interface ObjectFolderModel

All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<ObjectFolder>, com.liferay.portal.kernel.model.ClassedModel, Cloneable, Comparable<ObjectFolder>, 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:
ObjectFolder
All Known Implementing Classes:
ObjectFolderWrapper

@ProviderType public interface ObjectFolderModel extends com.liferay.portal.kernel.model.BaseModel<ObjectFolder>, 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 ObjectFolder service. Represents a row in the "ObjectFolder" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.object.model.impl.ObjectFolderModelImpl 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.ObjectFolderImpl.

See Also:
Generated:
  • Method Summary

    Modifier and Type
    Method
    Description
     
     
    long
    Returns the company ID of this object folder.
    Returns the create date of this object folder.
     
    Returns the external reference code of this object folder.
    Returns the label of this object folder.
    getLabel(String languageId)
    Returns the localized label of this object folder in the language.
    getLabel(String languageId, boolean useDefault)
    Returns the localized label of this object folder in the language, optionally using the default language if no localization exists for the requested language.
    getLabel(Locale locale)
    Returns the localized label of this object folder in the language.
    getLabel(Locale locale, boolean useDefault)
    Returns the localized label of this object folder 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 folder.
    Returns the modified date of this object folder.
    long
    Returns the mvcc version of this object folder.
    Returns the name of this object folder.
    long
    Returns the object folder ID of this object folder.
    long
    Returns the primary key of this object folder.
    long
    Returns the user ID of this object folder.
    Returns the user name of this object folder.
    Returns the user uuid of this object folder.
    Returns the uuid of this object folder.
    void
     
    void
     
    void
    setCompanyId(long companyId)
    Sets the company ID of this object folder.
    void
    setCreateDate(Date createDate)
    Sets the create date of this object folder.
    void
    setExternalReferenceCode(String externalReferenceCode)
    Sets the external reference code of this object folder.
    void
    Sets the label of this object folder.
    void
    setLabel(String label, Locale locale)
    Sets the localized label of this object folder in the language.
    void
    setLabel(String label, Locale locale, Locale defaultLocale)
    Sets the localized label of this object folder in the language, and sets the default locale.
    void
     
    void
    Sets the localized labels of this object folder from the map of locales and localized labels.
    void
    setLabelMap(Map<Locale,String> labelMap, Locale defaultLocale)
    Sets the localized labels of this object folder from the map of locales and localized labels, and sets the default locale.
    void
    setModifiedDate(Date modifiedDate)
    Sets the modified date of this object folder.
    void
    setMvccVersion(long mvccVersion)
    Sets the mvcc version of this object folder.
    void
    Sets the name of this object folder.
    void
    setObjectFolderId(long objectFolderId)
    Sets the object folder ID of this object folder.
    void
    setPrimaryKey(long primaryKey)
    Sets the primary key of this object folder.
    void
    setUserId(long userId)
    Sets the user ID of this object folder.
    void
    setUserName(String userName)
    Sets the user name of this object folder.
    void
    setUserUuid(String userUuid)
    Sets the user uuid of this object folder.
    void
    Sets the uuid of this object folder.
    default String
     

    Methods 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, toUnescapedModel

    Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

    getModelClass, getModelClassName

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface com.liferay.portal.kernel.model.StagedModel

    clone, getStagedModelType
  • Method Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this object folder.
      Returns:
      the primary key of this object folder
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this object folder.
      Parameters:
      primaryKey - the primary key of this object folder
    • getMvccVersion

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

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

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

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

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

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

      long getObjectFolderId()
      Returns the object folder ID of this object folder.
      Returns:
      the object folder ID of this object folder
    • setObjectFolderId

      void setObjectFolderId(long objectFolderId)
      Sets the object folder ID of this object folder.
      Parameters:
      objectFolderId - the object folder ID of this object folder
    • getCompanyId

      long getCompanyId()
      Returns the company ID of this object folder.
      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 folder
    • setCompanyId

      void setCompanyId(long companyId)
      Sets the company ID of this object folder.
      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 folder
    • getUserId

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

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

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

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

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

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

      Date getCreateDate()
      Returns the create date of this object folder.
      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 folder
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this object folder.
      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 folder
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this object folder.
      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 folder
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this object folder.
      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 folder
    • getLabel

      String getLabel()
      Returns the label of this object folder.
      Returns:
      the label of this object folder
    • getLabel

      @AutoEscape String getLabel(Locale locale)
      Returns the localized label of this object folder 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 folder
    • getLabel

      @AutoEscape String getLabel(Locale locale, boolean useDefault)
      Returns the localized label of this object folder 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 folder. 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 folder 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 folder
    • getLabel

      @AutoEscape String getLabel(String languageId, boolean useDefault)
      Returns the localized label of this object folder 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 folder
    • 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 folder.
      Returns:
      the locales and localized labels of this object folder
    • setLabel

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

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

      void setLabel(String label, Locale locale, Locale defaultLocale)
      Sets the localized label of this object folder in the language, and sets the default locale.
      Parameters:
      label - the localized label of this object folder
      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 folder from the map of locales and localized labels.
      Parameters:
      labelMap - the locales and localized labels of this object folder
    • setLabelMap

      void setLabelMap(Map<Locale,String> labelMap, Locale defaultLocale)
      Sets the localized labels of this object folder from the map of locales and localized labels, and sets the default locale.
      Parameters:
      labelMap - the locales and localized labels of this object folder
      defaultLocale - the default locale
    • getName

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

      void setName(String name)
      Sets the name of this object folder.
      Parameters:
      name - the name of this object folder
    • 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

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

      default String toXmlString()