Interface ObjectRelationshipModel

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

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

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

See Also:
Generated:
  • Method Summary

    Modifier and Type
    Method
    Description
     
     
    long
    Returns the company ID of this object relationship.
    Returns the create date of this object relationship.
    Returns the db table name of this object relationship.
     
    Returns the deletion type of this object relationship.
    boolean
    Returns the edge of this object relationship.
    Returns the external reference code of this object relationship.
    Returns the label of this object relationship.
    getLabel(String languageId)
    Returns the localized label of this object relationship in the language.
    getLabel(String languageId, boolean useDefault)
    Returns the localized label of this object relationship 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 relationship in the language.
    getLabel(Locale locale, boolean useDefault)
    Returns the localized label of this object relationship 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 relationship.
    Returns the modified date of this object relationship.
    long
    Returns the mvcc version of this object relationship.
    Returns the name of this object relationship.
    long
    Returns the object definition id1 of this object relationship.
    long
    Returns the object definition id2 of this object relationship.
    long
    Returns the object field id2 of this object relationship.
    long
    Returns the object relationship ID of this object relationship.
    long
    Returns the parameter object field ID of this object relationship.
    long
    Returns the primary key of this object relationship.
    boolean
    Returns the reverse of this object relationship.
    boolean
    Returns the system of this object relationship.
    Returns the type of this object relationship.
    long
    Returns the user ID of this object relationship.
    Returns the user name of this object relationship.
    Returns the user uuid of this object relationship.
    Returns the uuid of this object relationship.
    boolean
    Returns true if this object relationship is edge.
    boolean
    Returns true if this object relationship is reverse.
    boolean
    Returns true if this object relationship is system.
    void
     
    void
     
    void
    setCompanyId(long companyId)
    Sets the company ID of this object relationship.
    void
    setCreateDate(Date createDate)
    Sets the create date of this object relationship.
    void
    setDBTableName(String dbTableName)
    Sets the db table name of this object relationship.
    void
    setDeletionType(String deletionType)
    Sets the deletion type of this object relationship.
    void
    setEdge(boolean edge)
    Sets whether this object relationship is edge.
    void
    setExternalReferenceCode(String externalReferenceCode)
    Sets the external reference code of this object relationship.
    void
    Sets the label of this object relationship.
    void
    setLabel(String label, Locale locale)
    Sets the localized label of this object relationship in the language.
    void
    setLabel(String label, Locale locale, Locale defaultLocale)
    Sets the localized label of this object relationship in the language, and sets the default locale.
    void
     
    void
    Sets the localized labels of this object relationship from the map of locales and localized labels.
    void
    setLabelMap(Map<Locale,String> labelMap, Locale defaultLocale)
    Sets the localized labels of this object relationship from the map of locales and localized labels, and sets the default locale.
    void
    setModifiedDate(Date modifiedDate)
    Sets the modified date of this object relationship.
    void
    setMvccVersion(long mvccVersion)
    Sets the mvcc version of this object relationship.
    void
    Sets the name of this object relationship.
    void
    setObjectDefinitionId1(long objectDefinitionId1)
    Sets the object definition id1 of this object relationship.
    void
    setObjectDefinitionId2(long objectDefinitionId2)
    Sets the object definition id2 of this object relationship.
    void
    setObjectFieldId2(long objectFieldId2)
    Sets the object field id2 of this object relationship.
    void
    setObjectRelationshipId(long objectRelationshipId)
    Sets the object relationship ID of this object relationship.
    void
    setParameterObjectFieldId(long parameterObjectFieldId)
    Sets the parameter object field ID of this object relationship.
    void
    setPrimaryKey(long primaryKey)
    Sets the primary key of this object relationship.
    void
    setReverse(boolean reverse)
    Sets whether this object relationship is reverse.
    void
    setSystem(boolean system)
    Sets whether this object relationship is system.
    void
    Sets the type of this object relationship.
    void
    setUserId(long userId)
    Sets the user ID of this object relationship.
    void
    setUserName(String userName)
    Sets the user name of this object relationship.
    void
    setUserUuid(String userUuid)
    Sets the user uuid of this object relationship.
    void
    Sets the uuid of this object relationship.
    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 relationship.
      Returns:
      the primary key of this object relationship
    • setPrimaryKey

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

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

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

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

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

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

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

      long getObjectRelationshipId()
      Returns the object relationship ID of this object relationship.
      Returns:
      the object relationship ID of this object relationship
    • setObjectRelationshipId

      void setObjectRelationshipId(long objectRelationshipId)
      Sets the object relationship ID of this object relationship.
      Parameters:
      objectRelationshipId - the object relationship ID of this object relationship
    • getCompanyId

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

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

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

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

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

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

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

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

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

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

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

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

      long getObjectDefinitionId1()
      Returns the object definition id1 of this object relationship.
      Returns:
      the object definition id1 of this object relationship
    • setObjectDefinitionId1

      void setObjectDefinitionId1(long objectDefinitionId1)
      Sets the object definition id1 of this object relationship.
      Parameters:
      objectDefinitionId1 - the object definition id1 of this object relationship
    • getObjectDefinitionId2

      long getObjectDefinitionId2()
      Returns the object definition id2 of this object relationship.
      Returns:
      the object definition id2 of this object relationship
    • setObjectDefinitionId2

      void setObjectDefinitionId2(long objectDefinitionId2)
      Sets the object definition id2 of this object relationship.
      Parameters:
      objectDefinitionId2 - the object definition id2 of this object relationship
    • getObjectFieldId2

      long getObjectFieldId2()
      Returns the object field id2 of this object relationship.
      Returns:
      the object field id2 of this object relationship
    • setObjectFieldId2

      void setObjectFieldId2(long objectFieldId2)
      Sets the object field id2 of this object relationship.
      Parameters:
      objectFieldId2 - the object field id2 of this object relationship
    • getParameterObjectFieldId

      long getParameterObjectFieldId()
      Returns the parameter object field ID of this object relationship.
      Returns:
      the parameter object field ID of this object relationship
    • setParameterObjectFieldId

      void setParameterObjectFieldId(long parameterObjectFieldId)
      Sets the parameter object field ID of this object relationship.
      Parameters:
      parameterObjectFieldId - the parameter object field ID of this object relationship
    • getDeletionType

      @AutoEscape String getDeletionType()
      Returns the deletion type of this object relationship.
      Returns:
      the deletion type of this object relationship
    • setDeletionType

      void setDeletionType(String deletionType)
      Sets the deletion type of this object relationship.
      Parameters:
      deletionType - the deletion type of this object relationship
    • getDBTableName

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

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

      boolean getEdge()
      Returns the edge of this object relationship.
      Returns:
      the edge of this object relationship
    • isEdge

      boolean isEdge()
      Returns true if this object relationship is edge.
      Returns:
      true if this object relationship is edge; false otherwise
    • setEdge

      void setEdge(boolean edge)
      Sets whether this object relationship is edge.
      Parameters:
      edge - the edge of this object relationship
    • getLabel

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

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

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

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

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

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

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

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

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

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

      boolean getReverse()
      Returns the reverse of this object relationship.
      Returns:
      the reverse of this object relationship
    • isReverse

      boolean isReverse()
      Returns true if this object relationship is reverse.
      Returns:
      true if this object relationship is reverse; false otherwise
    • setReverse

      void setReverse(boolean reverse)
      Sets whether this object relationship is reverse.
      Parameters:
      reverse - the reverse of this object relationship
    • getSystem

      boolean getSystem()
      Returns the system of this object relationship.
      Returns:
      the system of this object relationship
    • isSystem

      boolean isSystem()
      Returns true if this object relationship is system.
      Returns:
      true if this object relationship is system; false otherwise
    • setSystem

      void setSystem(boolean system)
      Sets whether this object relationship is system.
      Parameters:
      system - the system of this object relationship
    • getType

      @AutoEscape String getType()
      Returns the type of this object relationship.
      Returns:
      the type of this object relationship
    • setType

      void setType(String type)
      Sets the type of this object relationship.
      Parameters:
      type - the type of this object relationship
    • 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

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

      default String toXmlString()