Group (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.personalization.GroupBase
- - com.appiancorp.suiteapi.personalization.Group

All Implemented Interfaces:

LocalId, java.io.Serializable
```
@GroupDataType
public class Group
extends GroupBase
implements LocalId
```
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:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.Long`	`MEMBERPOLICY_AUTOMATIC`
`static java.lang.Long`	`MEMBERPOLICY_CLOSED`
`static java.lang.Long`	`MEMBERPOLICY_EXCLUSIVE`
`static java.lang.Long`	`NULL_PARENT_ID` This is the value returned by `getParentId()` when the group doesn't have a parent.
`static java.lang.Integer`	`SORT_BY_ATTRIBUTES`
`static java.lang.Integer`	`SORT_BY_CREATED`
`static java.lang.Integer`	`SORT_BY_CREATOR`
`static java.lang.Integer`	`SORT_BY_DESCRIPTION`
`static java.lang.Integer`	`SORT_BY_GROUP_NAME` Sort constants for getting and searching for groups.
`static java.lang.Integer`	`SORT_BY_GROUPTYPE_ID`
`static java.lang.Integer`	`SORT_BY_GROUPTYPE_NAME`
`static java.lang.Integer`	`SORT_BY_ID`
`static java.lang.Integer`	`SORT_BY_LAST_MODIFIED`
`static java.lang.Integer`	`SORT_BY_MEMBER_POLICY_ID`
`static java.lang.Integer`	`SORT_BY_MEMBER_POLICY_NAME`
`static java.lang.Integer`	`SORT_BY_PARENT_ID`
`static java.lang.Integer`	`SORT_BY_PARENT_NAME`
`static java.lang.Integer`	`SORT_BY_SECURITY_MAP_ID`
`static java.lang.Integer`	`SORT_BY_SECURITY_MAP_NAME`
`static java.lang.Integer`	`SORT_BY_VIEWING_POLICY_ID`
`static java.lang.Integer`	`SORT_BY_VIEWING_POLICY_NAME`
`static java.lang.Long`	`VIEWINGPOLICY_HIGH`
`static java.lang.Long`	`VIEWINGPOLICY_LOW`

Fields inherited from class com.appiancorp.suiteapi.personalization.GroupBase
SECURITYMAP_PERSONAL, SECURITYMAP_PUBLIC, SECURITYMAP_TEAM

Constructor Summary

Constructors
Constructor and Description
`Group()`
`Group(java.lang.Long groupTypeId, java.lang.String name)` Instantiate a group with the fields that must be populated to create the group in the database.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`Attribute[]`	`getAttributes()`
`boolean`	`getDelegatedCreation()` Decide whether delegated creation field be visible to the client
`java.lang.String`	`getDescription()`
`boolean`	`getFavorite()`
`java.lang.Long`	`getGroupTypeId()` Returns the id of this group's type.
`java.lang.Long`	`getId()` Returns the id of this Group.
`static java.lang.Long[]`	`getIds(Group[] groups)` Get the ids (as a Long array) from an array of Group objects.
`java.lang.Long`	`getMemberPolicyId()`
`java.lang.String`	`getMemberPolicyName()`
`java.lang.Long`	`getParentId()`
`java.lang.String`	`getSecurityMapName()`
`java.lang.String`	`getUuid()` Returns the UUID of this Group.
`java.lang.Long`	`getViewingPolicyId()`
`java.lang.String`	`getViewingPolicyName()`
`int`	`hashCode()`
`void`	`setAttributes(Attribute[] attributes)`
`void`	`setDelegatedCreation(boolean delegatedCreation_)`
`void`	`setDescription(java.lang.String description)`
`void`	`setFavorite(boolean favorite_)`
`void`	`setGroupTypeId(java.lang.Long groupTypeId)`
`void`	`setId(java.lang.Long p)` Sets this object's local identifier.
`void`	`setMemberPolicyId(java.lang.Long memberPolicyId)` Sets the memberPolicyId.
`void`	`setMemberPolicyName(java.lang.String memberPolicyName)` The name corresponding to viewing policy id.
`void`	`setParentId(java.lang.Long parentId)`
`void`	`setSecurityMapName(java.lang.String securityMapName)` The name corresponding to security map id.
`void`	`setUuid(java.lang.String uuid)` Set the UUID of this Group.
`void`	`setViewingPolicyId(java.lang.Long viewingPolicyId)` Sets the viewingPolicyId.
`void`	`setViewingPolicyName(java.lang.String viewingPolicyName)` The name corresponding to viewing policy id.
`java.lang.String`	`toString()`

Methods inherited from class com.appiancorp.suiteapi.personalization.GroupBase
getCreated, getCreator, getGroupName, getGroupTypeName, getLastModified, getParentName, getSecurityMapId, setCreated, setCreator, setGroupName, setGroupTypeName, setLastModified, setParentName, setSecurityMapId

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SORT_BY_GROUP_NAME
```
public static final java.lang.Integer SORT_BY_GROUP_NAME
```
    Sort constants for getting and searching for groups.
  - SORT_BY_PARENT_NAME
```
public static final java.lang.Integer SORT_BY_PARENT_NAME
```
  - SORT_BY_CREATOR
```
public static final java.lang.Integer SORT_BY_CREATOR
```
  - SORT_BY_CREATED
```
public static final java.lang.Integer SORT_BY_CREATED
```
  - SORT_BY_LAST_MODIFIED
```
public static final java.lang.Integer SORT_BY_LAST_MODIFIED
```
  - SORT_BY_GROUPTYPE_NAME
```
public static final java.lang.Integer SORT_BY_GROUPTYPE_NAME
```
  - SORT_BY_ID
```
public static final java.lang.Integer SORT_BY_ID
```
  - SORT_BY_DESCRIPTION
```
public static final java.lang.Integer SORT_BY_DESCRIPTION
```
  - SORT_BY_PARENT_ID
```
public static final java.lang.Integer SORT_BY_PARENT_ID
```
  - SORT_BY_GROUPTYPE_ID
```
public static final java.lang.Integer SORT_BY_GROUPTYPE_ID
```
  - SORT_BY_SECURITY_MAP_ID
```
public static final java.lang.Integer SORT_BY_SECURITY_MAP_ID
```
  - SORT_BY_ATTRIBUTES
```
public static final java.lang.Integer SORT_BY_ATTRIBUTES
```
  - SORT_BY_MEMBER_POLICY_ID
```
public static final java.lang.Integer SORT_BY_MEMBER_POLICY_ID
```
  - SORT_BY_VIEWING_POLICY_ID
```
public static final java.lang.Integer SORT_BY_VIEWING_POLICY_ID
```
  - SORT_BY_SECURITY_MAP_NAME
```
public static final java.lang.Integer SORT_BY_SECURITY_MAP_NAME
```
  - SORT_BY_MEMBER_POLICY_NAME
```
public static final java.lang.Integer SORT_BY_MEMBER_POLICY_NAME
```
  - SORT_BY_VIEWING_POLICY_NAME
```
public static final java.lang.Integer SORT_BY_VIEWING_POLICY_NAME
```
  - MEMBERPOLICY_AUTOMATIC
```
public static final java.lang.Long MEMBERPOLICY_AUTOMATIC
```
  - MEMBERPOLICY_EXCLUSIVE
```
public static final java.lang.Long MEMBERPOLICY_EXCLUSIVE
```
  - MEMBERPOLICY_CLOSED
```
public static final java.lang.Long MEMBERPOLICY_CLOSED
```
  - VIEWINGPOLICY_LOW
```
public static final java.lang.Long VIEWINGPOLICY_LOW
```
  - VIEWINGPOLICY_HIGH
```
public static final java.lang.Long VIEWINGPOLICY_HIGH
```
  - NULL_PARENT_ID
```
public static final java.lang.Long NULL_PARENT_ID
```
    This is the value returned by getParentId() when the group doesn't have a parent.
- Constructor Detail
  - Group
```
public Group()
```
  - Group
```
public Group(java.lang.Long groupTypeId,
             java.lang.String name)
```
    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 Detail
  - getId
```
public java.lang.Long getId()
```
    Returns the id of this Group.
    
    Specified by:
    
    getId in interface LocalId
    
    Returns:
    
    Object's Id
    
    See Also:
    
    LocalId.setId(Long)
  - setId
```
public void setId(java.lang.Long p)
```
    Description copied from interface: LocalId
    
    Sets this object's local identifier.
    
    Specified by:
    
    setId in interface LocalId
    
    Parameters:
    
    p - Id to set
    
    See Also:
    
    LocalId.getId()
  - getUuid
```
@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class)
public java.lang.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
```
public void setUuid(java.lang.String uuid)
```
    Set the UUID of this Group. This value is ignored, except when the Group is being created.
  - getDescription
```
public java.lang.String getDescription()
```
  - setDescription
```
public void setDescription(java.lang.String description)
```
  - getParentId
```
public java.lang.Long getParentId()
```
  - setParentId
```
public void setParentId(java.lang.Long parentId)
```
  - getGroupTypeId
```
public java.lang.Long getGroupTypeId()
```
    Returns the id of this group's type.
  - setGroupTypeId
```
public void setGroupTypeId(java.lang.Long groupTypeId)
```
  - getAttributes
```
public Attribute[] getAttributes()
```
  - setAttributes
```
public void setAttributes(Attribute[] attributes)
```
  - getDelegatedCreation
```
public boolean getDelegatedCreation()
```
    Decide whether delegated creation field be visible to the client
  - setDelegatedCreation
```
public void setDelegatedCreation(boolean delegatedCreation_)
```
  - getMemberPolicyId
```
public java.lang.Long getMemberPolicyId()
```
  - setMemberPolicyId
```
public void setMemberPolicyId(java.lang.Long memberPolicyId)
```
    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
```
public java.lang.Long getViewingPolicyId()
```
  - setViewingPolicyId
```
public void setViewingPolicyId(java.lang.Long viewingPolicyId)
```
    Sets the viewingPolicyId. Supported types are VIEWINGPOLICY_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
```
public java.lang.String getMemberPolicyName()
```
    Returns:
    
    Returns the memberPolicyName.
  - setMemberPolicyName
```
public void setMemberPolicyName(java.lang.String memberPolicyName)
```
    The name corresponding to viewing policy id.
    
    Parameters:
    
    memberPolicyName - The member policy name to set.
    
    See Also:
    
    setMemberPolicyId(java.lang.Long)
  - getSecurityMapName
```
public java.lang.String getSecurityMapName()
```
    Returns:
    
    Returns the securityMapName.
  - setSecurityMapName
```
public void setSecurityMapName(java.lang.String securityMapName)
```
    The name corresponding to security map id.
    
    Parameters:
    
    securityMapName - The securityMapName to set.
    
    See Also:
    
    GroupBase.setSecurityMapId(java.lang.Long)
  - getViewingPolicyName
```
public java.lang.String getViewingPolicyName()
```
    Returns:
    
    Returns the viewingPolicyName.
  - setViewingPolicyName
```
public void setViewingPolicyName(java.lang.String viewingPolicyName)
```
    The name corresponding to viewing policy id.
    
    Parameters:
    
    viewingPolicyName - The viewingPolicyName to set.
    
    See Also:
    
    setViewingPolicyId(java.lang.Long)
  - getFavorite
```
public boolean getFavorite()
```
  - setFavorite
```
public void setFavorite(boolean favorite_)
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class GroupBase
  - getIds
```
public static java.lang.Long[] getIds(Group[] groups)
```
    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

Class Group

Field Summary

Fields inherited from class com.appiancorp.suiteapi.personalization.GroupBase

Constructor Summary

Method Summary

Methods inherited from class com.appiancorp.suiteapi.personalization.GroupBase

Methods inherited from class java.lang.Object

Field Detail

SORT_BY_GROUP_NAME

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

Constructor Detail

Group

Group

Method Detail

getId

setId

getUuid

setUuid

getDescription

setDescription

getParentId

setParentId

getGroupTypeId

setGroupTypeId

getAttributes

setAttributes

getDelegatedCreation

setDelegatedCreation

getMemberPolicyId

setMemberPolicyId

getViewingPolicyId

setViewingPolicyId

getMemberPolicyName

setMemberPolicyName

getSecurityMapName

setSecurityMapName

getViewingPolicyName

setViewingPolicyName

getFavorite

setFavorite

equals

hashCode

toString

getIds