Interface UserGroupModel

All Superinterfaces:
AuditedModel, BaseModel<UserGroup>, ClassedModel, Cloneable, Comparable<UserGroup>, CTModel<UserGroup>, ExternalReferenceCodeModel, MVCCModel, Serializable, ShardedModel, StagedAuditedModel, StagedModel
All Known Subinterfaces:
UserGroup
All Known Implementing Classes:
UserGroupWrapper

@ProviderType public interface UserGroupModel extends BaseModel<UserGroup>, CTModel<UserGroup>, ExternalReferenceCodeModel, MVCCModel, ShardedModel, StagedAuditedModel
The base model interface for the UserGroup service. Represents a row in the "UserGroup" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.portal.model.impl.UserGroupModelImpl 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.portal.model.impl.UserGroupImpl.

Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Method Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this user group.
      Specified by:
      getPrimaryKey in interface CTModel<UserGroup>
      Returns:
      the primary key of this user group
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this user group.
      Specified by:
      setPrimaryKey in interface CTModel<UserGroup>
      Parameters:
      primaryKey - the primary key of this user group
    • getMvccVersion

      long getMvccVersion()
      Returns the mvcc version of this user group.
      Specified by:
      getMvccVersion in interface MVCCModel
      Returns:
      the mvcc version of this user group
    • setMvccVersion

      void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this user group.
      Specified by:
      setMvccVersion in interface MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this user group
    • getCtCollectionId

      long getCtCollectionId()
      Returns the ct collection ID of this user group.
      Specified by:
      getCtCollectionId in interface CTModel<UserGroup>
      Returns:
      the ct collection ID of this user group
    • setCtCollectionId

      void setCtCollectionId(long ctCollectionId)
      Sets the ct collection ID of this user group.
      Specified by:
      setCtCollectionId in interface CTModel<UserGroup>
      Parameters:
      ctCollectionId - the ct collection ID of this user group
    • getUuid

      @AutoEscape String getUuid()
      Returns the uuid of this user group.
      Specified by:
      getUuid in interface StagedModel
      Returns:
      the uuid of this user group
    • setUuid

      void setUuid(String uuid)
      Sets the uuid of this user group.
      Specified by:
      setUuid in interface StagedModel
      Parameters:
      uuid - the uuid of this user group
    • getExternalReferenceCode

      @AutoEscape String getExternalReferenceCode()
      Returns the external reference code of this user group.
      Specified by:
      getExternalReferenceCode in interface ExternalReferenceCodeModel
      Returns:
      the external reference code of this user group
    • setExternalReferenceCode

      void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this user group.
      Specified by:
      setExternalReferenceCode in interface ExternalReferenceCodeModel
      Parameters:
      externalReferenceCode - the external reference code of this user group
    • getUserGroupId

      long getUserGroupId()
      Returns the user group ID of this user group.
      Returns:
      the user group ID of this user group
    • setUserGroupId

      void setUserGroupId(long userGroupId)
      Sets the user group ID of this user group.
      Parameters:
      userGroupId - the user group ID of this user group
    • getCompanyId

      long getCompanyId()
      Returns the company ID of this user group.
      Specified by:
      getCompanyId in interface AuditedModel
      Specified by:
      getCompanyId in interface ShardedModel
      Specified by:
      getCompanyId in interface StagedModel
      Returns:
      the company ID of this user group
    • setCompanyId

      void setCompanyId(long companyId)
      Sets the company ID of this user group.
      Specified by:
      setCompanyId in interface AuditedModel
      Specified by:
      setCompanyId in interface ShardedModel
      Specified by:
      setCompanyId in interface StagedModel
      Parameters:
      companyId - the company ID of this user group
    • getUserId

      long getUserId()
      Returns the user ID of this user group.
      Specified by:
      getUserId in interface AuditedModel
      Returns:
      the user ID of this user group
    • setUserId

      void setUserId(long userId)
      Sets the user ID of this user group.
      Specified by:
      setUserId in interface AuditedModel
      Parameters:
      userId - the user ID of this user group
    • getUserUuid

      String getUserUuid()
      Returns the user uuid of this user group.
      Specified by:
      getUserUuid in interface AuditedModel
      Returns:
      the user uuid of this user group
    • setUserUuid

      void setUserUuid(String userUuid)
      Sets the user uuid of this user group.
      Specified by:
      setUserUuid in interface AuditedModel
      Parameters:
      userUuid - the user uuid of this user group
    • getUserName

      @AutoEscape String getUserName()
      Returns the user name of this user group.
      Specified by:
      getUserName in interface AuditedModel
      Returns:
      the user name of this user group
    • setUserName

      void setUserName(String userName)
      Sets the user name of this user group.
      Specified by:
      setUserName in interface AuditedModel
      Parameters:
      userName - the user name of this user group
    • getCreateDate

      Date getCreateDate()
      Returns the create date of this user group.
      Specified by:
      getCreateDate in interface AuditedModel
      Specified by:
      getCreateDate in interface StagedModel
      Returns:
      the create date of this user group
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this user group.
      Specified by:
      setCreateDate in interface AuditedModel
      Specified by:
      setCreateDate in interface StagedModel
      Parameters:
      createDate - the create date of this user group
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this user group.
      Specified by:
      getModifiedDate in interface AuditedModel
      Specified by:
      getModifiedDate in interface StagedModel
      Returns:
      the modified date of this user group
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this user group.
      Specified by:
      setModifiedDate in interface AuditedModel
      Specified by:
      setModifiedDate in interface StagedModel
      Parameters:
      modifiedDate - the modified date of this user group
    • getParentUserGroupId

      long getParentUserGroupId()
      Returns the parent user group ID of this user group.
      Returns:
      the parent user group ID of this user group
    • setParentUserGroupId

      void setParentUserGroupId(long parentUserGroupId)
      Sets the parent user group ID of this user group.
      Parameters:
      parentUserGroupId - the parent user group ID of this user group
    • getName

      @AutoEscape String getName()
      Returns the name of this user group.
      Returns:
      the name of this user group
    • setName

      void setName(String name)
      Sets the name of this user group.
      Parameters:
      name - the name of this user group
    • getDescription

      @AutoEscape String getDescription()
      Returns the description of this user group.
      Returns:
      the description of this user group
    • setDescription

      void setDescription(String description)
      Sets the description of this user group.
      Parameters:
      description - the description of this user group
    • getAddedByLDAPImport

      boolean getAddedByLDAPImport()
      Returns the added by ldap import of this user group.
      Returns:
      the added by ldap import of this user group
    • isAddedByLDAPImport

      boolean isAddedByLDAPImport()
      Returns true if this user group is added by ldap import.
      Returns:
      true if this user group is added by ldap import; false otherwise
    • setAddedByLDAPImport

      void setAddedByLDAPImport(boolean addedByLDAPImport)
      Sets whether this user group is added by ldap import.
      Parameters:
      addedByLDAPImport - the added by ldap import of this user group
    • cloneWithOriginalValues

      UserGroup cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface BaseModel<UserGroup>
    • toXmlString

      default String toXmlString()