Package com.appiancorp.suiteapi.content

Class ContentRoleMap

java.lang.Object
com.appiancorp.suiteapi.common.RoleMap
com.appiancorp.suiteapi.content.ContentRoleMap
All Implemented Interfaces:
XMLable, Serializable, Map
public class ContentRoleMap extends RoleMap

This class represents the access permissions for an element in the collaboration center.

Copyright: Copyright (c) 2002, 2003

Company: Appian Corporation

See Also:

  • Field Details

  • Constructor Details

    • ContentRoleMap

      public ContentRoleMap()

  • 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:

    • getAggregateAdministrators

      public String[] getAggregateAdministrators()
      Retrieves the users who have administrative permissions aggregated via the chain of parent objects.
      Returns:
      a list containing the unique IDs of the users

    • getAdministratorGroups

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

    • getAggregateAdministratorGroups

      public Long[] getAggregateAdministratorGroups()
      Retrieves the groups who have administrative permissions aggregated via the chain of parent object.
      Returns:
      a list containing the unique IDs of the groups

    • setAdministrators

      public void setAdministrators(String... unames_)
      Sets the users who have administrative permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users
      See Also:

    • setAdministratorGroups

      public void setAdministratorGroups(Long... grids_)
      Sets the groups who have administrative permissions.
      Parameters:
      grids_ - a list 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_ - a list containing the unique IDs of the users to be added

    • addAdministratorGroups

      public void addAdministratorGroups(Long... grids_)
      Appends to the groups who have administrative permissions.
      Parameters:
      grids_ - a list 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_ - a list containing the unique IDs of the users to be deleted

    • removeAdministratorGroups

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

    • getAuthors

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

    • getAggregateAuthors

      public String[] getAggregateAuthors()
      Retrieves the users who have authoring permissions aggregated via the chain of parent objects.
      Returns:
      a list containing the unique IDs of the users

    • getAuthorGroups

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

    • getAggregateAuthorGroups

      public Long[] getAggregateAuthorGroups()
      Retrieves the groups who have authoring permissions aggregated via the chain of parent objects.
      Returns:
      a list containing the unique IDs of the groups

    • getReaders

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

    • getAggregateReaders

      public String[] getAggregateReaders()
      Retrieves the users who have read-only permissions aggregated via the chain of parent objects.
      Returns:
      a list containing the unique IDs of the users who have read-only permissions

    • getReaderGroups

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

    • getAggregateReaderGroups

      public Long[] getAggregateReaderGroups()
      Retrieves the groups who have read-only permissions aggregated via the chain of parent objects.
      Returns:
      a list containing the unique IDs the groups who have read-only permissions

    • setAuthors

      public void setAuthors(String... unames_)
      Sets the users who have authoring (read/write) permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users
      See Also:

    • setAuthorGroups

      public void setAuthorGroups(Long... grids_)
      Sets the groups who have authoring (read/write) permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups
      See Also:

    • setReaders

      public void setReaders(String... unames_)
      Sets the users who have read-only permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users
      See Also:

    • setReaderGroups

      public void setReaderGroups(Long... grids_)
      Sets the groups who have authoring read-only permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups
      See Also:

    • addAuthors

      public void addAuthors(String... unames_)
      Appends to the users who have authoring (read/write) permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • addAuthorGroups

      public void addAuthorGroups(Long... grids_)
      Appends to the groups who have authoring (read/write) permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • addReaders

      public void addReaders(String... unames_)
      Appends to the users who have read-only permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • addReaderGroups

      public void addReaderGroups(Long... grids_)
      Appends to the groups who have read-only permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • removeAuthors

      public void removeAuthors(String... unames_)
      Delete from the users who have authoring (read/write) permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • removeAuthorGroups

      public void removeAuthorGroups(Long... grids_)
      Delete from the groups who have authoring (read/write) permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • removeReaders

      public void removeReaders(String... unames_)
      Delete from the users who have read-only permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • removeReaderGroups

      public void removeReaderGroups(Long... grids_)
      Delete from the groups who have read-only permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • getDenyAdministrators

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

    • getAggregateDenyAdministrators

      public String[] getAggregateDenyAdministrators()
      Retrieves the users who have been explicitly denied administrative permissions aggregated via the chain of parent objects.
      Returns:
      a list containing the unique IDs of the users

    • getDenyAdministratorGroups

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

    • getAggregateDenyAdministratorGroups

      public Long[] getAggregateDenyAdministratorGroups()
      Retrieves the groups who have been explicitly denied administrative permissions aggregated via the chain of parent objects.
      Returns:
      a list containing the unique IDs of the groups

    • setDenyAdministrators

      public void setDenyAdministrators(String... unames_)
      Sets the users who have been explicitly denied administrative permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users
      See Also:

    • setDenyAdministratorGroups

      public void setDenyAdministratorGroups(Long... grids_)
      Sets the groups who have been explicitly denied administrative permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups
      See Also:

    • addDenyAdministrators

      public void addDenyAdministrators(String... unames_)
      Appends to the users who have been explicitly denied administrative permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users to be added

    • addDenyAdministratorGroups

      public void addDenyAdministratorGroups(Long... grids_)
      Appends to the groups who have been explicitly denied administrative permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be added

    • removeDenyAdministrators

      public void removeDenyAdministrators(String... unames_)
      Deletes from the users who have been explicitly denied administrative permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users to be deleted

    • removeDenyAdministratorGroups

      public void removeDenyAdministratorGroups(Long... grids_)
      Deletes from the groups who have been explicitly denied administrative permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups to be deleted

    • getDenyAuthors

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

    • getAggregateDenyAuthors

      public String[] getAggregateDenyAuthors()
      Retrieves the users who have been explicitly denied authoring permissions aggregated via the chain of parent objects.
      Returns:
      a list containing the unique IDs of the users who have authoring (read/write) permissions

    • getDenyAuthorGroups

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

    • getAggregateDenyAuthorGroups

      public Long[] getAggregateDenyAuthorGroups()
      Retrieves the groups who have been explicitly denied authoring permissions aggregated via the chain of parent objects.
      Returns:
      a list containing the unique IDs of the groups who have authoring (read/write) permissions

    • getDenyReaders

      public String[] getDenyReaders()
      Retrieves the users who have been explicitly denied read-only permissions.
      Returns:
      a list containing the unique IDs of the users who have read-only permissions
      See Also:

    • getAggregateDenyReaders

      public String[] getAggregateDenyReaders()
      Retrieves the users who have been explicitly denied read-only permissions aggregated via the chain of parent objects.
      Returns:
      a list containing the unique IDs of the users who have read-only permissions

    • getDenyReaderGroups

      public Long[] getDenyReaderGroups()
      Retrieves the groups who have been explicitly denied read-only permissions.
      Returns:
      a list containing the unique IDs the groups who have read-only permissions
      See Also:

    • getAggregateDenyReaderGroups

      public Long[] getAggregateDenyReaderGroups()
      Retrieves the groups who have been explicitly denied read-only permissions aggregated via the chain of parent objects.
      Returns:
      a list containing the unique IDs the groups who have read-only permissions

    • setDenyAuthors

      public void setDenyAuthors(String... unames_)
      Sets the users who have been explicitly denied authoring (read/write) permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users
      See Also:

    • setDenyAuthorGroups

      public void setDenyAuthorGroups(Long... grids_)
      Sets the groups who have been explicitly denied authoring (read/write) permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups
      See Also:

    • setDenyReaders

      public void setDenyReaders(String... unames_)
      Sets the users who have been explicitly denied read-only permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users
      See Also:

    • setDenyReaderGroups

      public void setDenyReaderGroups(Long... grids_)
      Sets the groups who have been explicitly denied authoring read-only permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups
      See Also:

    • addDenyAuthors

      public void addDenyAuthors(String... unames_)
      Appends to the users who have been explicitly denied authoring (read/write) permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • addDenyAuthorGroups

      public void addDenyAuthorGroups(Long... grids_)
      Appends to the groups who have been explicitly denied authoring (read/write) permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • addDenyReaders

      public void addDenyReaders(String... unames_)
      Appends to the users who have been explicitly denied read-only permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • addDenyReaderGroups

      public void addDenyReaderGroups(Long... grids_)
      Appends to the groups who have been explicitly denied read-only permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • removeDenyAuthors

      public void removeDenyAuthors(String... unames_)
      Delete from the users who have been explicitly denied authoring (read/write) permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • removeDenyAuthorGroups

      public void removeDenyAuthorGroups(Long... grids_)
      Delete from the groups who have been explicitly denied authoring (read/write) permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • removeDenyReaders

      public void removeDenyReaders(String... unames_)
      Delete from the users who have been explicitly denied read-only permissions.
      Parameters:
      unames_ - a list containing the unique IDs of the users

    • removeDenyReaderGroups

      public void removeDenyReaderGroups(Long... grids_)
      Delete from the groups who have been explicitly denied read-only permissions.
      Parameters:
      grids_ - a list containing the unique IDs of the groups

    • isPublic

      public boolean isPublic()
      Indicates that the content is public. The difference between public and non-public content is the editor role; for non-public, someone with just editor (not edit) before they can create, delete, or update content.

    • setPublic

      public void setPublic(boolean secPublic)
      See Also:

    • getRoles

      public ContentRole[] getRoles()
      Returns an array of ContentRole objects for every Content role (see ContentConstants.ROLE_MAP_ROLES).
      Overrides:
      getRoles in class RoleMap

    • setRoles

      public void setRoles(Role[] roles)
      Removes any roles that are currently set and sets the roles to the given data. If the given array is null or empty the existing roles are cleared.
      Overrides:
      setRoles in class RoleMap
      Parameters:
      roles - The roles data to set in the role map.

    • setRoles

      public void setRoles(Collection<? extends Role> roles)
      Removes any roles that are currently set and sets the roles to the given data. If the given array is null or empty the existing roles are cleared.
      Overrides:
      setRoles in class RoleMap
      Parameters:
      roles - The collection of roles data to set in the role map.

    • removeAllRoles

      protected void removeAllRoles()
      Overrides:
      removeAllRoles in class RoleMap

    • getRole

      protected ContentRole getRole(String roleName)
      Overrides:
      getRole in class RoleMap

    • setRole

      protected void setRole(Role role)
      Overrides:
      setRole in class RoleMap

    • mergeWith

      public void mergeWith(RoleMap newRM)
      Description copied from class: RoleMap
      Merges this role map with the given new role map. Only the fields RoleMap.TYPE_USER and RoleMap.TYPE_GROUP are merged. All other fields are left unchanged. The following rules are used to merge the users and groups:
      1. The merged role map should be the union of the existing and new role maps.
      2. When the same user/group is present in both the existing and new role maps, the role from the NEW role map should be used for the user/group.
      Overrides:
      mergeWith in class RoleMap
      Parameters:
      newRM - The new role map to merge with this (existing/old) role map.

    • toString

      public String toString()
      Overrides:
      toString in class RoleMap

    • toStringSecurityVector

      public static String toStringSecurityVector(Integer contentSecurityVector)