Class PublicRoleMap

java.lang.Object
com.appiancorp.suiteapi.common.RoleMap
com.appiancorp.suiteapi.common.PublicRoleMap
All Implemented Interfaces:
XMLable, Serializable, Map
Direct Known Subclasses:
AEVRoleMap, ForumsRoleMap

public class PublicRoleMap extends RoleMap
Defines the roles of users and groups for an object.
See Also:
  • Field Details

  • Constructor Details

    • PublicRoleMap

      public PublicRoleMap()
  • Method Details

    • getAdministrators

      public String[] getAdministrators()
      Retrieves the users who have administrative permissions.
      Returns:
      an Array containing the unique IDs (usernames) of the users.
      See Also:
    • getAdministratorGroups

      public Long[] getAdministratorGroups()
      Retrieves the groups who have administrative permissions.
      Returns:
      an Array containing the unique IDs of the groups.
      See Also:
    • setAdministrators

      public void setAdministrators(String[] unames_)
      Sets the users who have administrative permissions.
      Parameters:
      unames_ - an Array containing the unique IDs (usernames) of the users.
      See Also:
    • setAdministratorGroups

      public void setAdministratorGroups(Long[] grids_)
      Sets the groups who have administrative permissions.
      Parameters:
      grids_ - an Array containing the unique IDs of the groups
      See Also:
    • addAdministrators

      public void addAdministrators(String[] unames_)
      Appends to the users who have administrative permissions.
      Parameters:
      unames_ - an Array containing the unique IDs (usernames) of the users to be added
    • addAdministratorGroups

      public void addAdministratorGroups(Long[] grids_)
      Appends to the groups who have administrative permissions.
      Parameters:
      grids_ - an Array containing the unique IDs of the groups to be added
    • removeAdministrators

      public void removeAdministrators(String[] unames_)
      Deletes from the users who have administrative permissions.
      Parameters:
      unames_ - an Array containing the unique IDs (usernames) of the users to be deleted
    • removeAdministratorGroups

      public void removeAdministratorGroups(Long[] grids_)
      Deletes from the groups who have administrative permissions.
      Parameters:
      grids_ - an Array containing the unique IDs of the groups to be deleted