Package com.liferay.portal.kernel.model
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 Summary
Modifier and TypeMethodDescriptionboolean
Returns the added by ldap import of this user group.long
Returns the company ID of this user group.Returns the create date of this user group.long
Returns the ct collection ID of this user group.Returns the description of this user group.Returns the external reference code of this user group.Returns the modified date of this user group.long
Returns the mvcc version of this user group.getName()
Returns the name of this user group.long
Returns the parent user group ID of this user group.long
Returns the primary key of this user group.long
Returns the user group ID of this user group.long
Returns the user ID of this user group.Returns the user name of this user group.Returns the user uuid of this user group.getUuid()
Returns the uuid of this user group.boolean
Returnstrue
if this user group is added by ldap import.void
setAddedByLDAPImport
(boolean addedByLDAPImport) Sets whether this user group is added by ldap import.void
setCompanyId
(long companyId) Sets the company ID of this user group.void
setCreateDate
(Date createDate) Sets the create date of this user group.void
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID of this user group.void
setDescription
(String description) Sets the description of this user group.void
setExternalReferenceCode
(String externalReferenceCode) Sets the external reference code of this user group.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this user group.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this user group.void
Sets the name of this user group.void
setParentUserGroupId
(long parentUserGroupId) Sets the parent user group ID of this user group.void
setPrimaryKey
(long primaryKey) Sets the primary key of this user group.void
setUserGroupId
(long userGroupId) Sets the user group ID of this user group.void
setUserId
(long userId) Sets the user ID of this user group.void
setUserName
(String userName) Sets the user name of this user group.void
setUserUuid
(String userUuid) Sets the user uuid of this user group.void
Sets the uuid of this user group.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 user group.- Specified by:
getPrimaryKey
in interfaceCTModel<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 interfaceCTModel<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 interfaceMVCCModel
- 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 interfaceMVCCModel
- 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 interfaceCTModel<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 interfaceCTModel<UserGroup>
- Parameters:
ctCollectionId
- the ct collection ID of this user group
-
getUuid
Returns the uuid of this user group.- Specified by:
getUuid
in interfaceStagedModel
- Returns:
- the uuid of this user group
-
setUuid
Sets the uuid of this user group.- Specified by:
setUuid
in interfaceStagedModel
- Parameters:
uuid
- the uuid of this user group
-
getExternalReferenceCode
Returns the external reference code of this user group.- Specified by:
getExternalReferenceCode
in interfaceExternalReferenceCodeModel
- Returns:
- the external reference code of this user group
-
setExternalReferenceCode
Sets the external reference code of this user group.- Specified by:
setExternalReferenceCode
in interfaceExternalReferenceCodeModel
- 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 interfaceAuditedModel
- Specified by:
getCompanyId
in interfaceShardedModel
- Specified by:
getCompanyId
in interfaceStagedModel
- 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 interfaceAuditedModel
- Specified by:
setCompanyId
in interfaceShardedModel
- Specified by:
setCompanyId
in interfaceStagedModel
- Parameters:
companyId
- the company ID of this user group
-
getUserId
long getUserId()Returns the user ID of this user group.- Specified by:
getUserId
in interfaceAuditedModel
- 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 interfaceAuditedModel
- Parameters:
userId
- the user ID of this user group
-
getUserUuid
String getUserUuid()Returns the user uuid of this user group.- Specified by:
getUserUuid
in interfaceAuditedModel
- Returns:
- the user uuid of this user group
-
setUserUuid
Sets the user uuid of this user group.- Specified by:
setUserUuid
in interfaceAuditedModel
- Parameters:
userUuid
- the user uuid of this user group
-
getUserName
Returns the user name of this user group.- Specified by:
getUserName
in interfaceAuditedModel
- Returns:
- the user name of this user group
-
setUserName
Sets the user name of this user group.- Specified by:
setUserName
in interfaceAuditedModel
- Parameters:
userName
- the user name of this user group
-
getCreateDate
Date getCreateDate()Returns the create date of this user group.- Specified by:
getCreateDate
in interfaceAuditedModel
- Specified by:
getCreateDate
in interfaceStagedModel
- Returns:
- the create date of this user group
-
setCreateDate
Sets the create date of this user group.- Specified by:
setCreateDate
in interfaceAuditedModel
- Specified by:
setCreateDate
in interfaceStagedModel
- Parameters:
createDate
- the create date of this user group
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this user group.- Specified by:
getModifiedDate
in interfaceAuditedModel
- Specified by:
getModifiedDate
in interfaceStagedModel
- Returns:
- the modified date of this user group
-
setModifiedDate
Sets the modified date of this user group.- Specified by:
setModifiedDate
in interfaceAuditedModel
- Specified by:
setModifiedDate
in interfaceStagedModel
- 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
Returns the name of this user group.- Returns:
- the name of this user group
-
setName
Sets the name of this user group.- Parameters:
name
- the name of this user group
-
getDescription
Returns the description of this user group.- Returns:
- the description of this user group
-
setDescription
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()Returnstrue
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 interfaceBaseModel<UserGroup>
-
toXmlString
-