Package com.logicaldoc.core.security
Class Group
- java.lang.Object
 - 
- com.logicaldoc.core.PersistentObject
 - 
- com.logicaldoc.core.security.Group
 
 
 
- 
- All Implemented Interfaces:
 Serializable
public class Group extends PersistentObject implements Serializable
This class represents groups.
Groups have a type that qualifies the group usage as follows:- DEFAULT (0): Standard group of users
 - USER (1): Group of a user(one to one relationship), it is hidden and not editable using admin tools
 
- Version:
 - 1.0
 - Author:
 - Michael Scholz, Marco Meschieri
 - See Also:
 - Serialized Form
 
 
- 
- 
Field Summary
Fields Modifier and Type Field Description static longGROUPID_ADMINstatic longGROUPID_PUBLISHERstatic intTYPE_DEFAULTstatic intTYPE_USER- 
Fields inherited from class com.logicaldoc.core.PersistentObject
DELETED_CODE_DEFAULT, DELETED_CODE_STRONG 
 - 
 
- 
Constructor Summary
Constructors Constructor Description Group() 
- 
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclearUsers()StringgetDescription()StringgetName()StringgetSource()intgetType()UsergetUser()If this is a user group, then it returns the userSet<User>getUsers()booleanisAdmin()booleanisGuest()Check if this group is the guest or is the user's group of a guest userbooleanisUserGroup()voidreset()voidsetDescription(String description)voidsetName(String name)voidsetSource(String source)voidsetType(int type)voidsetUsers(Set<User> users)StringtoString()- 
Methods inherited from class com.logicaldoc.core.PersistentObject
equals, getDeleted, getId, getLastModified, getRecordVersion, getTenantId, hashCode, setDeleted, setId, setLastModified, setRecordVersion, setTenantId 
 - 
 
 - 
 
- 
- 
Field Detail
- 
GROUPID_ADMIN
public static final long GROUPID_ADMIN
- See Also:
 - Constant Field Values
 
 
- 
GROUPID_PUBLISHER
public static final long GROUPID_PUBLISHER
- See Also:
 - Constant Field Values
 
 
- 
TYPE_DEFAULT
public static int TYPE_DEFAULT
 
- 
TYPE_USER
public static int TYPE_USER
 
 - 
 
- 
Method Detail
- 
getType
public int getType()
 
- 
setType
public void setType(int type)
 
- 
getName
public String getName()
 
- 
getDescription
public String getDescription()
 
- 
setName
public void setName(String name)
 
- 
setDescription
public void setDescription(String description)
 
- 
reset
public void reset()
 
- 
clearUsers
public void clearUsers()
 
- 
toString
public String toString()
- Overrides:
 toStringin classPersistentObject
 
- 
isUserGroup
public boolean isUserGroup()
 
- 
getUser
public User getUser()
If this is a user group, then it returns the user- Returns:
 - the user
 
 
- 
isGuest
public boolean isGuest()
Check if this group is the guest or is the user's group of a guest user- Returns:
 - if this is the guest group or is the user's group of a guest user
 
 
- 
isAdmin
public boolean isAdmin()
 
- 
getSource
public String getSource()
 
- 
setSource
public void setSource(String source)
 
 - 
 
 -