Class Group
java.lang.Object
com.appiancorp.suiteapi.personalization.GroupBase
com.appiancorp.suiteapi.personalization.Group
- All Implemented Interfaces:
LocalId
,Serializable
This represents the Group object. Name of group must be unique. If the group is of a group type with attributes, you must pass the correct attribute list with the correct name and type for each attribute with the group. Note that when a group specifies a parent, it automatically becomes a member group of its parent.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Long
static final Long
static final Long
static final Long
This is the value returned bygetParentId()
when the group doesn't have a parent.static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
Sort constants for getting and searching for groups.static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
static final Integer
static final Long
static final Long
Fields inherited from class com.appiancorp.suiteapi.personalization.GroupBase
SECURITYMAP_PERSONAL, SECURITYMAP_PUBLIC, SECURITYMAP_TEAM
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
Decide whether delegated creation field be visible to the clientboolean
Returns the id of this group's type.getId()
Returns the id of this Group.static Long[]
Get the ids (as a Long array) from an array of Group objects.getUuid()
Returns the UUID of this Group.int
hashCode()
void
setAttributes
(Attribute[] attributes) void
setDelegatedCreation
(boolean delegatedCreation_) void
setDescription
(String description) void
setFavorite
(boolean favorite_) void
setGroupTypeId
(Long groupTypeId) void
Sets this object's local identifier.void
setMemberPolicyId
(Long memberPolicyId) Sets the memberPolicyId.void
setMemberPolicyName
(String memberPolicyName) The name corresponding to viewing policy id.void
setParentId
(Long parentId) void
setSecurityMapName
(String securityMapName) The name corresponding to security map id.void
Set the UUID of this Group.void
setViewingPolicyId
(Long viewingPolicyId) Sets the viewingPolicyId.void
setViewingPolicyName
(String viewingPolicyName) The name corresponding to viewing policy id.toString()
Methods inherited from class com.appiancorp.suiteapi.personalization.GroupBase
getCreated, getCreator, getGroupName, getGroupTypeName, getLastModified, getParentName, getSecurityMapId, setCreated, setCreator, setGroupName, setGroupTypeName, setLastModified, setParentName, setSecurityMapId
-
Field Details
-
SORT_BY_GROUP_NAME
Sort constants for getting and searching for groups. -
SORT_BY_PARENT_NAME
-
SORT_BY_CREATOR
-
SORT_BY_CREATED
-
SORT_BY_LAST_MODIFIED
-
SORT_BY_GROUPTYPE_NAME
-
SORT_BY_ID
-
SORT_BY_DESCRIPTION
-
SORT_BY_PARENT_ID
-
SORT_BY_GROUPTYPE_ID
-
SORT_BY_SECURITY_MAP_ID
-
SORT_BY_ATTRIBUTES
-
SORT_BY_MEMBER_POLICY_ID
-
SORT_BY_VIEWING_POLICY_ID
-
SORT_BY_SECURITY_MAP_NAME
-
SORT_BY_MEMBER_POLICY_NAME
-
SORT_BY_VIEWING_POLICY_NAME
-
MEMBERPOLICY_AUTOMATIC
-
MEMBERPOLICY_EXCLUSIVE
-
MEMBERPOLICY_CLOSED
-
VIEWINGPOLICY_LOW
-
VIEWINGPOLICY_HIGH
-
NULL_PARENT_ID
This is the value returned bygetParentId()
when the group doesn't have a parent.
-
-
Constructor Details
-
Group
public Group() -
Group
Instantiate a group with the fields that must be populated to create the group in the database.- Parameters:
groupTypeId
- The id of the group's type.name
- The name of the group.
-
-
Method Details
-
getId
Returns the id of this Group. -
setId
Description copied from interface:LocalId
Sets this object's local identifier. -
getUuid
@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public String getUuid()Returns the UUID of this Group. This field is not populated unless:- the group is a system group (such as Portal Administrators)
- the group has previously been exported
- the group was assigned a UUID when it was created
- the group was assigned a UUID using the Import/Export API
-
setUuid
Set the UUID of this Group. This value is ignored, except when the Group is being created. -
getDescription
-
setDescription
-
getParentId
-
setParentId
-
getGroupTypeId
Returns the id of this group's type. -
setGroupTypeId
-
getAttributes
-
setAttributes
-
getDelegatedCreation
public boolean getDelegatedCreation()Decide whether delegated creation field be visible to the client -
setDelegatedCreation
public void setDelegatedCreation(boolean delegatedCreation_) -
getMemberPolicyId
-
setMemberPolicyId
Sets the memberPolicyId. Supported types are MEMBERPOLICY_AUTOMATIC, MEMBERPOLICY_CLOSED.MEMBERPOLICY_AUTOMATIC - Anyone can join if they can see the group
MEMBERPOLICY_CLOSED - Admins must select members of this group
- Parameters:
memberPolicyId
- The memberPolicyId to set.
-
getViewingPolicyId
-
setViewingPolicyId
Sets the viewingPolicyId. Supported types areVIEWINGPOLICY_HIGH
,VIEWINGPOLICY_LOW
VIEWINGPOLICY_HIGH - Only Admins can see members of the group
VIEWINGPOLICY_LOW - Anyone who can see the group can view its members
- Parameters:
viewingPolicyId
- The viewingPolicyId to set
-
getMemberPolicyName
- Returns:
- Returns the memberPolicyName.
-
setMemberPolicyName
The name corresponding to viewing policy id.- Parameters:
memberPolicyName
- The member policy name to set.- See Also:
-
getSecurityMapName
- Returns:
- Returns the securityMapName.
-
setSecurityMapName
The name corresponding to security map id.- Parameters:
securityMapName
- The securityMapName to set.- See Also:
-
getViewingPolicyName
- Returns:
- Returns the viewingPolicyName.
-
setViewingPolicyName
The name corresponding to viewing policy id.- Parameters:
viewingPolicyName
- The viewingPolicyName to set.- See Also:
-
getFavorite
public boolean getFavorite() -
setFavorite
public void setFavorite(boolean favorite_) -
equals
-
hashCode
public int hashCode() -
toString
-
getIds
Get the ids (as a Long array) from an array of Group objects.- Parameters:
groups
- an array of Groups- Returns:
- an array of the same size as the given array, containing the ids of the given Groups; if given array is null, returns null
-