Package com.appiancorp.suiteapi.applications

Class ApplicationRoleMap

java.lang.Object
com.appiancorp.suiteapi.applications.ApplicationRoleMap
public class ApplicationRoleMap extends Object

  • Constructor Details

    • ApplicationRoleMap

      public ApplicationRoleMap()

    • ApplicationRoleMap

      public ApplicationRoleMap(ContentRoleMap securityRoleMap)

  • Method Details

    • getAdministrators

      public String[] getAdministrators()
      Retrieves the users who have administrative permissions.
      Returns:
      a list containing the unique IDs of the users
      See Also:

    • getAdministratorGroups

      public Long[] getAdministratorGroups()
      Retrieves the groups who have administrative permissions.
      Returns:
      a list containing the unique IDs of the groups
      See Also:

    • setAdministrators

      public void setAdministrators(String[] usernames)
      Sets the users who have administrative permissions.
      Parameters:
      usernames - a list containing the usernames
      See Also:

    • setAdministratorGroups

      public void setAdministratorGroups(Long[] groupIds)
      Sets the groups who have administrative permissions.
      Parameters:
      groupIds - a list containing the ids of the groups
      See Also:

    • getEditors

      public String[] getEditors()
      Retrieves the users who have editor (read/write) permissions.
      Returns:
      a list containing the unique IDs of the users who have editor (read/write) permissions

    • setEditors

      public void setEditors(String[] usernames)
      Sets the users who have authoring (read/write) permissions.
      Parameters:
      usernames - a list containing the unique IDs of the users
      See Also:
      • #getAuthors()

    • getEditorGroups

      public Long[] getEditorGroups()
      Retrieves the groups who have authoring (read/write) permissions.
      Returns:
      a list containing the unique IDs of the groups
      See Also:
      • #setAuthorGroups(Long[])

    • setEditorGroups

      public void setEditorGroups(Long[] groupIds)
      Sets the groups who have editor (read/write) permissions.
      Parameters:
      groupIds - a list containing the group ids.

    • getViewers

      public String[] getViewers()
      Retrieves the users who have read-only permissions.
      Returns:
      a list containing the unique IDs of the users who have read-only permissions

    • getViewerGroups

      public Long[] getViewerGroups()
      Retrieves the groups who have read-only permissions.
      Returns:
      a list containing the unique IDs the groups who have read-only permissions
      See Also:
      • #setReaderGroups(Long[])

    • setViewers

      public void setViewers(String[] usernames)
      Sets the users who have read-only permissions.
      Parameters:
      usernames - a list containing the unique IDs of the users

    • setViewerGroups

      public void setViewerGroups(Long[] groupIds)
      Sets the groups who have read-only permissions.
      Parameters:
      groupIds - a list containing the unique IDs of the groups

    • setDeny

      public void setDeny(String[] usernames)
      A user assigned to the "Deny" level, either directly or via group membership, will NOT have ANY privileges on the application, regardless of membership in any other security level. "Deny" also overrides implicit viewer privileges granted by the "public" configuration. The exception is a System Administrator, whose privileges may not be overridden.
      Parameters:
      usernames - The list of usernames to be added to the Deny role.

    • getDeny

      public String[] getDeny()
      The users in the deny role.
      Returns:
      The users in the deny role.
      See Also:

    • setDenyGroups

      public void setDenyGroups(Long[] groupIds)
      A group assigned to the "Deny" level, will NOT have ANY privileges on the application, regardless of membership in any other security level. "Deny" also overrides implicit viewer privileges granted by the "public" configuration. The exception is a System Administrator, whose privileges may not be overridden.
      Parameters:
      groupIds - The list of groups to be added to the Deny role.

    • getDenyGroups

      public Long[] getDenyGroups()
      The list of groups in the deny role.
      Returns:
      the list of groups in the deny role.

    • getContentRoleMap

      public ContentRoleMap getContentRoleMap()

    • setContentRoleMap

      public void setContentRoleMap(ContentRoleMap crm)

    • toString

      public String toString()
      Overrides:
      toString in class Object