Package com.appiancorp.suiteapi.administration

Interface AdministrationService

All Superinterfaces:
com.appiancorp.services.ContextSensitiveService, Service
@Deprecated public interface AdministrationService extends com.appiancorp.services.ContextSensitiveService
Deprecated.
The AdministrationService pertains to the legacy admin console, which will be replaced by the Appian Administration Console over the coming releases.
Provides functionality related to the Administration Console

Methods of service classes can all throw the unchecked exception ServiceException if any system-level error (for example, server failure) occurs, and will in general throw a checked exception (InvalidXXXException) when an entity to be retrieved is inaccessible, instead of returning null. Exceptions to this paradigm (including the use of ResultList as described below) are noted. All checked exceptions extend AppianException.

It may be necessary to retrieve a subset of results as opposed to an entire collection, and also to sort the subset by some property of the returned object. "Paging" methods which return a ResultPage are provided in certain instances for this purpose. The ResultPage will contain the sorted subset of results (via Result.getResults()), and the total number of items in the available result set (via ResultPage.getAvailableItems()).

It may also be necessary to retrieve some results, even if all results cannot be retrieved (for instance, some of the entities corresponding to a list of entity IDs may no longer exist). Methods which return a ResultList are provided for this purpose. The Result.getResults() method in this case will return all results which can be retrieved. In addition, there will be a list of result codes (ResultList.getResultCodes()) that represent the successful retrieval of an entity, or, if the entity could not be retrieved, the reason for the failure. See the CODE_XXX constants in ResultList for details.

  • Field Details

    • getPermissionsForAdminConsole$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForAdminConsole$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setSecurityForAdminConsole$UPDATES

      @Deprecated(forRemoval=true) static final boolean setSecurityForAdminConsole$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSecurityForAdminConsole$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSecurityForAdminConsole$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setActorsInRolesForAdminConsole$UPDATES

      @Deprecated(forRemoval=true) static final boolean setActorsInRolesForAdminConsole$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • validateDatabase$UPDATES

      @Deprecated(forRemoval=true) static final boolean validateDatabase$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

  • Method Details

    • getPermissionsForAdminConsole

      @Read(K_PORTAL) AdminConsolePermissions getPermissionsForAdminConsole()
      Deprecated.
      Gets the permissions related to the Administration Console for the current user.
      Returns:
      The AdminConsolePermissions bean containing the privileges for the current user.

    • setSecurityForAdminConsole

      @Write(K_PORTAL) void setSecurityForAdminConsole(Security s_) throws PrivilegeException, InvalidUserException, InvalidGroupException
      Deprecated.
      Updates (overwrites) the security settings for the Administration Console.
      Parameters:
      s_ - The Security bean which contains the new security settings. All fields other than native in the Security object will be ignored. The native rolemap should be of type AdminConsoleRoleMap
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to change the security settings. A user must be an AdminConsoleRoleMap.EDITOR or a system administrator in order to change the security settings.
      InvalidUserException - if any user in the Security object's rolemap does not exist
      InvalidGroupException - if the group does not exist
      See Also:

    • getSecurityForAdminConsole

      @Read(K_PORTAL) Security getSecurityForAdminConsole()
      Deprecated.
      Returns a Security bean containing the security settings for the Administration Console. The native field of the returned Security will be populated with a role map of type AdminConsoleRoleMap; the inheritable field will be null.
      Returns:
      A Security bean containing the security settings for the Administration Console.
      See Also:

    • setActorsInRolesForAdminConsole

      @Write(K_PORTAL) void setActorsInRolesForAdminConsole(String[] users_, String[][] userRoles_, Long[] groups_, String[][] groupRoles_) throws PrivilegeException, InvalidUserException, InvalidGroupException
      Deprecated.
      Sets the permissions of users and groups for the Administration Console. This method will only update the roles for users and groups which are specified in the parameters. To overwrite roles for all users and groups use setSecurityForAdminConsole(Security)
      Parameters:
      users_ - the list of users (user names) whose roles are to be added/modified This parameter can be null, as long as userRoles_ is also null. If one is null and the other is not, a NullPointerException will be thrown. If the first dimension of both arrays is not the same length, then an ArrayIndexOutOfBoundsException will be thrown.
      userRoles_ - a 2-dimensional array of size [users_.length]. The String array userRoles_[i] represents the roles which users_[i] will have. (If this array is null or zero-length, the user has no explicit permissions in the Admin Console RoleMap). It is legal to have nulls within the array.
      groups_ - the list of groups whose roles are to be added/modified This parameter can be null, as long as groupRoles_ is also null. If one is null and the other is not, a NullPointerException will be thrown. If the first dimension of both arrays is not the same length, then an ArrayIndexOutOfBoundsException will be thrown.
      groupRoles_ - a 2-dimentional array of size [groups_.length]. The String array groupRoles_[i] represents the roles which groups_[i] will have. (If this array is null or zero-length, the group has no explicit permissions in the Admin Console RoleMap). It is legal to have nulls within the array for a particular group(s).
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to update the roles. A user must be an AdminConsoleRoleMap.EDITOR or a system administrator to change the security settings.
      InvalidUserException - if any of the users in users_ do not exist.
      InvalidGroupException - if the group doesn't exist

    • validateDatabase

      @Read(K_PORTAL) DatabaseStatus validateDatabase(int thoroughness_)
      Deprecated.
      Performs validation on the database(s) associated with this service.
      Parameters:
      thoroughness_ - indicates the level of thoroughness of the query. Values are DatabaseStatus.QUICK and DatabaseStatus.SLOW
      Returns:
      a DatabaseStatus object encapsulating the results of the validation query.