Package com.appiancorp.suiteapi.process

Class ProcessRoleMap

java.lang.Object
com.appiancorp.suiteapi.common.RoleMap
com.appiancorp.suiteapi.process.ProcessRoleMap
All Implemented Interfaces:
XMLable, Serializable, Map
public class ProcessRoleMap extends RoleMap
Defines the roles of users and groups for a process object. The possible roles are Administrator, Editor, Viewer, Manager, Initiator, Non Member.
See Also:

  • Field Details

  • Constructor Details

    • ProcessRoleMap

      public ProcessRoleMap()

    • ProcessRoleMap

      public ProcessRoleMap(RoleMap roleMap)

  • Method Details

    • getRoleForColumn

      public static String getRoleForColumn(int n)
      Returns the role type (string) for a role integer id
      Parameters:
      n - integer id of the role
      Returns:
      role type

    • getAdminOwners

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

    • getAdminOwnerGroups

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

    • setAdminOwners

      public void setAdminOwners(String[] unames_)
      Sets the users who have administrative permissions
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • setAdminOwnerGroups

      public void setAdminOwnerGroups(Long[] grids_)
      Sets the groups who have administrative permissions
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • addAdminOwners

      public void addAdminOwners(String[] unames_)
      Adds administrative permission for the users
      Parameters:
      unames_ - a list containing the unique IDs of the users to be added

    • addAdminOwnerGroups

      public void addAdminOwnerGroups(Long[] grids_)
      Adds administrative permission for the groups
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be added

    • removeAdminOwners

      public void removeAdminOwners(String[] unames_)
      Removes the administrative permission of the users
      Parameters:
      unames_ - a list containing the unique IDs of the users to be deleted

    • removeAdminOwnerGroups

      public void removeAdminOwnerGroups(Long[] grids_)
      Removes the administrative permission of the groups
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be deleted

    • getEditors

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

    • getEditorGroups

      public Long[] getEditorGroups()
      Retrieves the groups who have editor permissions
      Returns:
      a list containing the unique IDs of the groups

    • setEditors

      public void setEditors(String[] unames_)
      Sets the users who have editor permissions
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • setEditorGroups

      public void setEditorGroups(Long[] grids_)
      Sets the groups who have editor permissions
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • addEditors

      public void addEditors(String[] unames_)
      Adds editor permission to the users
      Parameters:
      unames_ - a list containing the unique IDs of the users to be added

    • addEditorGroups

      public void addEditorGroups(Long[] grids_)
      Adds editor permission to the groups
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be added

    • removeEditors

      public void removeEditors(String[] unames_)
      Removes editor permission of the users
      Parameters:
      unames_ - a list containing the unique IDs of the users to be deleted

    • removeEditorGroups

      public void removeEditorGroups(Long[] grids_)
      Removes editor permission of the groups
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be deleted

    • getViewers

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

    • getViewerGroups

      public Long[] getViewerGroups()
      Retrieves the groups who have viewer permissions
      Returns:
      a list containing the unique IDs of the groups

    • setViewers

      public void setViewers(String[] unames_)
      Sets the users who have viewer permissions
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • setViewerGroups

      public void setViewerGroups(Long[] grids_)
      Sets the groups who have viewer permissions
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • addViewers

      public void addViewers(String[] unames_)
      Adds viewer permission to the users
      Parameters:
      unames_ - a list containing the unique IDs of the users to be added

    • addViewerGroups

      public void addViewerGroups(Long[] grids_)
      Adds viewer permission to the groups
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be added

    • removeViewers

      public void removeViewers(String[] unames_)
      Deletes the viewer permission of the users
      Parameters:
      unames_ - a list containing the unique IDs of the users to be deleted

    • removeViewerGroups

      public void removeViewerGroups(Long[] grids_)
      Deletes the viewer permission of the groups
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be deleted

    • getAnalysts

      @Deprecated public String[] getAnalysts()
      Deprecated.

    • getInitiators

      public String[] getInitiators()
      Retrieves the users who have analyst permissions
      Returns:
      a list containing the unique IDs of the users

    • getAnalystGroups

      @Deprecated public Long[] getAnalystGroups()
      Deprecated.

    • getInitiatorGroups

      public Long[] getInitiatorGroups()
      Retrieves the groups who have analyst permissions
      Returns:
      a list containing the unique IDs of the groups

    • setAnalysts

      @Deprecated public void setAnalysts(String[] unames_)
      Deprecated.

    • setInitiators

      public void setInitiators(String[] unames_)
      Sets the users who have analyst permissions
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • setAnalystGroups

      @Deprecated public void setAnalystGroups(Long[] grids_)
      Deprecated.

    • setInitiatorGroups

      public void setInitiatorGroups(Long[] grids_)
      Sets the groups who have analyst permissions
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • addAnalysts

      @Deprecated public void addAnalysts(String[] unames_)
      Deprecated.

    • addInitiators

      public void addInitiators(String[] unames_)
      Adds analyst permission to the users
      Parameters:
      unames_ - a list containing the unique IDs of the users to be added

    • addAnalystGroups

      @Deprecated public void addAnalystGroups(Long[] grids_)
      Deprecated.

    • addInitiatorGroups

      public void addInitiatorGroups(Long[] grids_)
      Adds analyst permission to the groups
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be added

    • removeAnalysts

      @Deprecated public void removeAnalysts(String[] unames_)
      Deprecated.

    • removeInitiators

      public void removeInitiators(String[] unames_)
      Deletes analyst permissions from the users
      Parameters:
      unames_ - a list containing the unique IDs of the users to be deleted

    • removeAnalystGroups

      @Deprecated public void removeAnalystGroups(Long[] grids_)
      Deprecated.

    • removeInitiatorGroups

      public void removeInitiatorGroups(Long[] grids_)
      Deletes analyst permissions from the groups
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be deleted

    • getPowerUsers

      @Deprecated public String[] getPowerUsers()
      Deprecated.

    • getManagers

      public String[] getManagers()
      Retrieves the users who have power user permissions
      Returns:
      a list containing the unique IDs of the users

    • getPowerUserGroups

      @Deprecated public Long[] getPowerUserGroups()
      Deprecated.

    • getManagerGroups

      public Long[] getManagerGroups()
      Retrieves the groups who have power user permissions
      Returns:
      a list containing the unique IDs of the groups

    • setPowerUsers

      @Deprecated public void setPowerUsers(String[] unames_)
      Deprecated.

    • setManagers

      public void setManagers(String[] unames_)
      Sets the users who have power user permissions
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • setPowerUserGroups

      @Deprecated public void setPowerUserGroups(Long[] grids_)
      Deprecated.

    • setManagerGroups

      public void setManagerGroups(Long[] grids_)
      Sets the groups who have power user permissions
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • addPowerUsers

      @Deprecated public void addPowerUsers(String[] unames_)
      Deprecated.

    • addManagers

      public void addManagers(String[] unames_)
      Adds power user permissions to the users
      Parameters:
      unames_ - a list containing the unique IDs of the users to be added

    • addPowerUserGroups

      @Deprecated public void addPowerUserGroups(Long[] grids_)
      Deprecated.

    • addManagerGroups

      public void addManagerGroups(Long[] grids_)
      Adds power user permissions to the groups
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be added

    • removePowerUsers

      @Deprecated public void removePowerUsers(String[] unames_)
      Deprecated.

    • removeManagers

      public void removeManagers(String[] unames_)
      Deletes power user permissions from the users
      Parameters:
      unames_ - a list containing the unique IDs of the users to be deleted

    • removePowerUserGroups

      @Deprecated public void removePowerUserGroups(Long[] grids_)
      Deprecated.

    • removeManagerGroups

      public void removeManagerGroups(Long[] grids_)
      Deletes power user permissions from the groups
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be deleted

    • getExplicitNonViewers

      public String[] getExplicitNonViewers()
      Retrieves the users who have been explicitly denied permissions
      Returns:
      a list containing the unique IDs of the users

    • getExplicitNonViewerGroups

      public Long[] getExplicitNonViewerGroups()
      Retrieves the groups who have been explicitly denied permissions
      Returns:
      a list containing the unique IDs of the groups

    • setExplicitNonViewers

      public void setExplicitNonViewers(String[] unames_)
      Sets the users who have been explicitly denied permissions
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • setExplicitNonViewerGroups

      public void setExplicitNonViewerGroups(Long[] grids_)
      Sets the groups who have been explicitly denied permissions
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • addExplicitNonViewers

      public void addExplicitNonViewers(String[] unames_)
      Adds explicitly denied permission to the users
      Parameters:
      unames_ - a list containing the unique IDs of the users to be added

    • addExplicitNonViewerGroups

      public void addExplicitNonViewerGroups(Long[] grids_)
      Adds explicitly denied permission to the groups
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be added

    • removeExplicitNonViewers

      public void removeExplicitNonViewers(String[] unames_)
      Deletes explicitly denied permissions from the users
      Parameters:
      unames_ - a list containing the unique IDs of the users to be deleted

    • removeExplicitNonViewerGroups

      public void removeExplicitNonViewerGroups(Long[] grids_)
      Deletes explicitly denied permissions from the groups
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be deleted