Package com.appiancorp.suiteapi.personalization

Class Group

java.lang.Object
com.appiancorp.suiteapi.personalization.GroupBase
com.appiancorp.suiteapi.personalization.Group
All Implemented Interfaces:
LocalId, 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:

  • Field Details

    • SORT_BY_GROUP_NAME

      public static final Integer SORT_BY_GROUP_NAME
      Sort constants for getting and searching for groups.

    • SORT_BY_PARENT_NAME

      public static final Integer SORT_BY_PARENT_NAME

    • SORT_BY_CREATOR

      public static final Integer SORT_BY_CREATOR

    • SORT_BY_CREATED

      public static final Integer SORT_BY_CREATED

    • SORT_BY_LAST_MODIFIED

      public static final Integer SORT_BY_LAST_MODIFIED

    • SORT_BY_GROUPTYPE_NAME

      public static final Integer SORT_BY_GROUPTYPE_NAME

    • SORT_BY_ID

      public static final Integer SORT_BY_ID

    • SORT_BY_DESCRIPTION

      public static final Integer SORT_BY_DESCRIPTION

    • SORT_BY_PARENT_ID

      public static final Integer SORT_BY_PARENT_ID

    • SORT_BY_GROUPTYPE_ID

      public static final Integer SORT_BY_GROUPTYPE_ID

    • SORT_BY_SECURITY_MAP_ID

      public static final Integer SORT_BY_SECURITY_MAP_ID

    • SORT_BY_ATTRIBUTES

      public static final Integer SORT_BY_ATTRIBUTES

    • SORT_BY_MEMBER_POLICY_ID

      public static final Integer SORT_BY_MEMBER_POLICY_ID

    • SORT_BY_VIEWING_POLICY_ID

      public static final Integer SORT_BY_VIEWING_POLICY_ID

    • SORT_BY_SECURITY_MAP_NAME

      public static final Integer SORT_BY_SECURITY_MAP_NAME

    • SORT_BY_MEMBER_POLICY_NAME

      public static final Integer SORT_BY_MEMBER_POLICY_NAME

    • SORT_BY_VIEWING_POLICY_NAME

      public static final Integer SORT_BY_VIEWING_POLICY_NAME

    • MEMBERPOLICY_AUTOMATIC

      public static final Long MEMBERPOLICY_AUTOMATIC

    • MEMBERPOLICY_EXCLUSIVE

      public static final Long MEMBERPOLICY_EXCLUSIVE

    • MEMBERPOLICY_CLOSED

      public static final Long MEMBERPOLICY_CLOSED

    • VIEWINGPOLICY_LOW

      public static final Long VIEWINGPOLICY_LOW

    • VIEWINGPOLICY_HIGH

      public static final Long VIEWINGPOLICY_HIGH

    • NULL_PARENT_ID

      public static final Long NULL_PARENT_ID
      This is the value returned by getParentId() when the group doesn't have a parent.

  • Constructor Details

    • Group

      public Group()

    • Group

      public Group(Long groupTypeId, 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 Details

    • getId

      public Long getId()
      Returns the id of this Group.
      Specified by:
      getId in interface LocalId
      Returns:
      Object's Id
      See Also:

    • setId

      public void setId(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:

    • 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

      public void setUuid(String uuid)
      Set the UUID of this Group. This value is ignored, except when the Group is being created.

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • getParentId

      public Long getParentId()

    • setParentId

      public void setParentId(Long parentId)

    • getGroupTypeId

      public Long getGroupTypeId()
      Returns the id of this group's type.

    • setGroupTypeId

      public void setGroupTypeId(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 Long getMemberPolicyId()

    • setMemberPolicyId

      public void setMemberPolicyId(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 Long getViewingPolicyId()

    • setViewingPolicyId

      public void setViewingPolicyId(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 String getMemberPolicyName()
      Returns:
      Returns the memberPolicyName.

    • setMemberPolicyName

      public void setMemberPolicyName(String memberPolicyName)
      The name corresponding to viewing policy id.
      Parameters:
      memberPolicyName - The member policy name to set.
      See Also:

    • getSecurityMapName

      public String getSecurityMapName()
      Returns:
      Returns the securityMapName.

    • setSecurityMapName

      public void setSecurityMapName(String securityMapName)
      The name corresponding to security map id.
      Parameters:
      securityMapName - The securityMapName to set.
      See Also:

    • getViewingPolicyName

      public String getViewingPolicyName()
      Returns:
      Returns the viewingPolicyName.

    • setViewingPolicyName

      public void setViewingPolicyName(String viewingPolicyName)
      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

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class GroupBase

    • getIds

      public static 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