Interface AdministrationService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
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 Summary
Modifier and TypeFieldDescriptionstatic final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Gets the permissions related to the Administration Console for the current user.Deprecated.Returns aSecurity
bean containing the security settings for the Administration Console.void
setActorsInRolesForAdminConsole
(String[] users_, String[][] userRoles_, Long[] groups_, String[][] groupRoles_) Deprecated.Sets the permissions of users and groups for the Administration Console.void
Deprecated.Updates (overwrites) the security settings for the Administration Console.validateDatabase
(int thoroughness_) Deprecated.Performs validation on the database(s) associated with this service.Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
getPermissionsForAdminConsole$UPDATES
static final boolean getPermissionsForAdminConsole$UPDATESDeprecated.- See Also:
-
setSecurityForAdminConsole$UPDATES
static final boolean setSecurityForAdminConsole$UPDATESDeprecated.- See Also:
-
getSecurityForAdminConsole$UPDATES
static final boolean getSecurityForAdminConsole$UPDATESDeprecated.- See Also:
-
setActorsInRolesForAdminConsole$UPDATES
static final boolean setActorsInRolesForAdminConsole$UPDATESDeprecated.- See Also:
-
validateDatabase$UPDATES
static final boolean validateDatabase$UPDATESDeprecated.- See Also:
-
-
Method Details
-
getPermissionsForAdminConsole
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. - Throws:
ServiceException
- if any system-level error occurs
-
setSecurityForAdminConsole
void setSecurityForAdminConsole(Security s_) throws PrivilegeException, InvalidUserException, InvalidGroupException Deprecated.Updates (overwrites) the security settings for the Administration Console.- Parameters:
s_
- TheSecurity
bean which contains the new security settings. All fields other thannative
in theSecurity
object will be ignored. The native rolemap should be of typeAdminConsoleRoleMap
- Throws:
PrivilegeException
- if the current user does not have sufficient privileges to change the security settings. A user must be anAdminConsoleRoleMap.EDITOR
or a system administrator in order to change the security settings.InvalidUserException
- if any user in theSecurity
object's rolemap does not existServiceException
- if any system-level error occursInvalidGroupException
- if the group does not exist- See Also:
-
getSecurityForAdminConsole
Security getSecurityForAdminConsole()Deprecated.Returns aSecurity
bean containing the security settings for the Administration Console. Thenative
field of the returnedSecurity
will be populated with a role map of typeAdminConsoleRoleMap
; theinheritable
field will benull
.- Returns:
- A
Security
bean containing the security settings for the Administration Console. - Throws:
ServiceException
- if any system-level error occurs- See Also:
-
setActorsInRolesForAdminConsole
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 usesetSecurityForAdminConsole(Security)
- Parameters:
users_
- the list of users (user names) whose roles are to be added/modified This parameter can be null, as long asuserRoles_
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 asgroupRoles_
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 anAdminConsoleRoleMap.EDITOR
or a system administrator to change the security settings.InvalidUserException
- if any of the users inusers_
do not exist.ServiceException
- if any system-level error occursInvalidGroupException
- if the group doesn't exist
-
validateDatabase
Deprecated.Performs validation on the database(s) associated with this service.- Parameters:
thoroughness_
- indicates the level of thoroughness of the query. Values areDatabaseStatus.QUICK
andDatabaseStatus.SLOW
- Returns:
- a
DatabaseStatus
object encapsulating the results of the validation query.
-