OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.AuthorizationManager
Implementsosid.OsidManager
osid.authorization.AuthorizationProfile
Description

The authorization manager provides access to authorization sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • AuthorizationSession: a session to performs authorization checks
  • AuthorizationLookupSession: a session to look up Authorizations
  • AuthorizationQuerySession: a session to query Authorizations
  • AuthorizationSearchSession: a session to search Authorizations
  • AuthorizationAdminSession: a session to create, modify and delete Authorizations
  • AuthorizationNotificationSession: a session to receive messages pertaining to Authorization changes
  • AuthorizationVaultSession: a session to look up authorization to vault mappings
  • AuthorizationVaultAssignmentSession: a session to manage authorization to vault mappings
  • AuthorizationSmartVaultSession: a session to manage smart authorization vaults
  • FunctionLookupSession: a session to look up Functions
  • FunctionQuerySession: a session to query Functions
  • FunctionSearchSession: a session to search Functions
  • FunctionAdminSession: a session to create, modify and delete Functions
  • FunctionNotificationSession: a session to receive messages pertaining to Function changes
  • FunctionVaultSession: a session for looking up function and vault mappings
  • FunctionVaultAssignmentSession: a session for managing function and vault mappings
  • FunctionSmartVaultSession: a session to manage dynamic function vaults
  • QualifierLookupSession: a session to look up Qualifiers
  • QualifierQuerySession: a session to query Qualifiers
  • QualifierSearchSession: a session to search Qualifiers
  • QualifierAdminSession: a session to create, modify and delete Qualifiers
  • QualifierNotificationSession: a session to receive messages pertaining to Qualifier changes
  • QualifierHierarchySession: a session for traversing qualifier hierarchies
  • QualifierHierarchyDesignSession: a session for managing qualifier hierarchies
  • QualifierVaultSession: a session for looking up qualifier and vault mappings
  • QualifierVaultAssignmentSession: a session for managing qualifier and vault mappings
  • QualifierSmartVaultSession: a session to manage dynamic qualifier vaults
  • VaultLookupSession: a session to lookup vaults
  • VaultQuerySession: a session to query Vaults
  • VaultSearchSession : a session to search vaults
  • VaultAdminSession : a session to create, modify and delete vaults
  • VaultNotificationSession : a session to receive messages pertaining to Vault changes
  • VaultHierarchySession : a session to traverse the Vault hierarchy
  • VaultHierarchyDesignSession : a session to manage the Vault hierarchy
MethodgetAuthorizationSession
Description

Gets an AuthorizationSession which is responsible for performing authorization checks.

Returnosid.authorization.AuthorizationSessionan authorization session for this service
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorization() is false
ComplianceoptionalThis method must be implemented if supportsAuthorization() is true.
MethodgetAuthorizationSessionForVault
Description

Gets an AuthorizationSession which is responsible for performing authorization checks for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.AuthorizationSession an AuthorizationSession
ErrorsNOT_FOUND vaultId
NULL_ARGUMENT vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAuthorization() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorization() and supportsVisibleFederation() are true.
MethodgetAuthorizationLookupSession
Description

Gets the OsidSession associated with the authorization lookup service.

Returnosid.authorization.AuthorizationLookupSessionan AuthorizationLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationLookup() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationLookup() is true.
MethodgetAuthorizationLookupSessionForVault
Description

Gets the OsidSession associated with the authorization lookup service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.AuthorizationLookupSession an AuthorizationLookupSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAuthorizationLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationLookup() and supportsVisibleFederation() are true.
MethodgetAuthorizationQuerySession
Description

Gets the OsidSession associated with the authorization query service.

Returnosid.authorization.AuthorizationQuerySessionan AuthorizationQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationQuery() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationQuery() is true.
MethodgetAuthorizationQuerySessionForVault
Description

Gets the OsidSession associated with the authorization query service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.AuthorizationQuerySession an AuthorizationQuerySession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAuthorizationQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationQuery() and supportsVisibleFederation() are true.
MethodgetAuthorizationSearchSession
Description

Gets the OsidSession associated with the authorization search service.

Returnosid.authorization.AuthorizationSearchSessionan AuthorizationSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationSearch() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationSearch() is true.
MethodgetAuthorizationSearchSessionForVault
Description

Gets the OsidSession associated with the authorization search service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.AuthorizationSearchSession an AuthorizationSearchSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAuthorizationSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationSearch() and supportsVisibleFederation() are true.
MethodgetAuthorizationAdminSession
Description

Gets the OsidSession associated with the authorization administration service.

Returnosid.authorization.AuthorizationAdminSessionan AuthorizationAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationAdmin() is true.
MethodgetAuthorizationAdminSessionForVault
Description

Gets the OsidSession associated with the authorization admin service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.AuthorizationAdminSession an AuthorizationAdminSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAuthorizationAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationAdmin() and supportsVisibleFederation() are true.
MethodgetAuthorizationNotificationSession
Description

Gets the notification session for notifications pertaining to authorization changes.

Parametersosid.authorization.AuthorizationReceiverauthorizationReceiverthe authorization receiver
Returnosid.authorization.AuthorizationNotificationSessionan AuthorizationNotificationSession
ErrorsNULL_ARGUMENT authorizationReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationNotification() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationNotification() is true.
MethodgetAuthorizationNotificationSessionForVault
Description

Gets the OsidSession associated with the authorization notification service for the given vault.

Parametersosid.authorization.AuthorizationReceiverauthorizationReceiverthe authorization receiver
osid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.AuthorizationNotificationSession an AuthorizationNotificationSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT authorizationReceiver or vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAuthorizationNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationNotification() and supportsVisibleFederation() are true.
MethodgetAuthorizationVaultSession
Description

Gets the session for retrieving authorization to vault mappings.

Returnosid.authorization.AuthorizationVaultSessionan AuthorizationVaultSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationVault() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationVault() is true.
MethodgetAuthorizationVaultAssignmentSession
Description

Gets the session for assigning authorizations to vault mappings.

Returnosid.authorization.AuthorizationVaultAssignmentSessiona AuthorizationVaultAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationVaultAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationVaultAssignment() is true.
MethodgetAuthorizationSmartVaultSession
Description

Gets the session for managing dynamic authorization vaults.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.AuthorizationSmartVaultSessiona AuthorizationSmartVaultSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationSmartVault() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationSmartVault() is true.
MethodgetFunctionLookupSession
Description

Gets the OsidSession associated with the function lookup service.

Returnosid.authorization.FunctionLookupSessiona FunctionLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFunctionLookup() is false
ComplianceoptionalThis method must be implemented if supportsFunctionLookup() is true.
MethodgetFunctionLookupSessionForVault
Description

Gets the OsidSession associated with the function lookup service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.FunctionLookupSession a FunctionLookupSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFunctionLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsFunctionLookup() and supportsVisibleFederation() are true.
MethodgetFunctionQuerySession
Description

Gets the OsidSession associated with the function query service.

Returnosid.authorization.FunctionQuerySessiona FunctionQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFunctionQuery() is false
ComplianceoptionalThis method must be implemented if supportsFunctionQuery() is true.
MethodgetFunctionQuerySessionForVault
Description

Gets the OsidSession associated with the function query service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.FunctionQuerySessiona FunctionQuerySession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFunctionQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsFunctionQuery() and supportsVisibleFederation() are true.
MethodgetFunctionSearchSession
Description

Gets the OsidSession associated with the function search service.

Returnosid.authorization.FunctionSearchSessiona FunctionSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFunctionSearch() is false
ComplianceoptionalThis method must be implemented if supportsFunctionSearch() is true.
MethodgetFunctionSearchSessionForVault
Description

Gets the OsidSession associated with the function search service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.FunctionSearchSessiona FunctionSearchSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFunctionSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsFunctionSearch() and supportsVisibleFederation() are true.
MethodgetFunctionAdminSession
Description

Gets the OsidSession associated with the function administration service.

Returnosid.authorization.FunctionAdminSessiona FunctionAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFunctionAdmin() is false
ComplianceoptionalThis method must be implemented if supportsFunctionAdmin() is true.
MethodgetFunctionAdminSessionForVault
Description

Gets the OsidSession associated with the function admin service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.FunctionAdminSession a FunctionAdminSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFunctionAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsFunctionAdmin() and supportsVisibleFederation() are true.
MethodgetFunctionNotificationSession
Description

Gets the notification session for notifications pertaining to function changes.

Parametersosid.authorization.FunctionReceiverfunctionReceiverthe function receiver
Returnosid.authorization.FunctionNotificationSessiona FunctionNotificationSession
ErrorsNULL_ARGUMENT functionReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFunctionNotification() is false
ComplianceoptionalThis method must be implemented if supportsFunctionNotification() is true.
MethodgetFunctionNotificationSessionForVault
Description

Gets the OsidSession associated with the function notification service for the given vault.

Parametersosid.authorization.FunctionReceiverfunctionReceiverthe function receiver
osid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.FunctionNotificationSession a FunctionNotificationSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT functionReceiver or vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFunctionNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsFunctionNotification() and supportsVisibleFederation() are true.
MethodgetFunctionVaultSession
Description

Gets the session for retrieving function to vault mappings.

Returnosid.authorization.FunctionVaultSessiona FunctionVaultSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFunctionVault() is false
ComplianceoptionalThis method must be implemented if supportsFunctionVault() is true.
MethodgetFunctionVaultAssignmentSession
Description

Gets the session for assigning function to vault mappings.

Returnosid.authorization.FunctionVaultAssignmentSessiona FunctionVaultAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFunctionVaultAssignment() is false
ComplianceoptionalThis method must be implemented if supportsFunctionVaultAssignment() is true.
MethodgetFunctionSmartVaultSession
Description

Gets the session associated with the function smart vault for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.FunctionSmartVaultSessiona FunctionSmartVaultSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFunctionSmartVault() is false
ComplianceoptionalThis method must be implemented if supportsFunctionSmartVault() is true.
MethodgetQualifierLookupSession
Description

Gets the OsidSession associated with the qualifier lookup service.

Returnosid.authorization.QualifierLookupSessiona QualifierLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQualifierLookup() is false
ComplianceoptionalThis method must be implemented if supportsQualifierLookup() is true.
MethodgetQualifierLookupSessionForVault
Description

Gets the OsidSession associated with the qualifier lookup service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.QualifierLookupSessiona QualifierLookupSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQualifierLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQualifierLookup() and supportsVisibleFederation() are true.
MethodgetQualifierQuerySession
Description

Gets the OsidSession associated with the qualifier query service.

Returnosid.authorization.QualifierQuerySessiona QualifierQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQualifierQuery() is false
ComplianceoptionalThis method must be implemented if supportsQualifierQuery() is true.
MethodgetQualifierQuerySessionForVault
Description

Gets the OsidSession associated with the qualifier query service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.QualifierQuerySessiona QualifierQuerySession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQualifierQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQualifierQuery() and supportsVisibleFederation() are true.
MethodgetQualifierSearchSession
Description

Gets the OsidSession associated with the qualifier search service.

Returnosid.authorization.QualifierSearchSessiona QualifierSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQualifierSearch() is false
ComplianceoptionalThis method must be implemented if supportsQualifierSearch() is true.
MethodgetQualifierSearchSessionForVault
Description

Gets the OsidSession associated with the qualifier search service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.QualifierSearchSessiona QualifierSearchSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQualifierSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQualifierSearch() and supportsVisibleFederation() are true.
MethodgetQualifierAdminSession
Description

Gets the OsidSession associated with the qualifier administration service.

Returnosid.authorization.QualifierAdminSessiona QualifierAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQualifierAdmin() is false
ComplianceoptionalThis method must be implemented if supportsQualifierAdmin() is true.
MethodgetQualifierAdminSessionForVault
Description

Gets the OsidSession associated with the qualifier admin service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.QualifierAdminSessiona QualifierAdminSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQualifierAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQualifierAdmin() and supportsVisibleFederation() are true.
MethodgetQualifierNotificationSession
Description

Gets the notification session for notifications pertaining to qualifier changes.

Parametersosid.authorization.QualifierReceiverqualifierReceiverthe qualifier receiver
Returnosid.authorization.QualifierNotificationSessiona QualifierNotificationSession
ErrorsNULL_ARGUMENT qualifierReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQualifierNotification() is false
ComplianceoptionalThis method must be implemented if supportsQualifierNotification() is true.
MethodgetQualifierNotificationSessionForVault
Description

Gets the OsidSession associated with the qualifier notification service for the given vault.

Parametersosid.authorization.QualifierReceiverqualifierReceiverthe qualifier receiver
osid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.QualifierNotificationSessiona QualifierNotificationSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT qualifierReceiver or vaultId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQualifierNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQualifierNotification() and supportsVisibleFederation() are true.
MethodgetQualifierHierarchySession
Description

Gets the OsidSession associated with the qualifier hierarchy traversal service. The authorization service uses distinct hierarchies that can be managed through a Hierarchy OSID.

Parametersosid.id.IdqualifierHierarchyIdthe Id of a qualifier hierarchy
Returnosid.authorization.QualifierHierarchySessiona QualifierHierarchySession
ErrorsNOT_FOUND qualifierHierarchyId not found
NULL_ARGUMENT qualifierHierarchyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQualifierHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsQualifierHierarchy() is true.
MethodgetQualifierHierarchyDesignSession
Description

Gets the OsidSession associated with the qualifier hierarchy design service.

Parametersosid.id.IdqualifierHierarchyIdthe Id of a qualifier hierarchy
Returnosid.authorization.QualifierHierarchyDesignSessiona QualifierHierarchyDesignSession
ErrorsNOT_FOUND qualifierHierarchyId not found
NULL_ARGUMENT qualifierHierarchyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQualifierHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsQualifierHierarchyDesign() is true.
MethodgetQualifierVaultSession
Description

Gets the session for retrieving qualifier to vault mappings.

Returnosid.authorization.QualifierVaultSessiona QualifierVaultSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQualifierVault() is false
ComplianceoptionalThis method must be implemented if supportsQualifierVault() is true.
MethodgetQualifierVaultAssignmentSession
Description

Gets the session for assigning qualifier to vault mappings.

Returnosid.authorization.QualifierVaultSessiona QualifierVaultAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQualifierVaultAssignment() is false
ComplianceoptionalThis method must be implemented if supportsQualifierVaultAssignment() is true.
MethodgetQualifierSmartVaultSession
Description

Gets the session associated with the qualifier smart vault for the given vault.

Parametersosid.id.IdvaultIdthe Id of the vault
Returnosid.authorization.QualifierSmartVaultSessiona QualifierSmartVaultSession
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQualifierSmartVault() is false
ComplianceoptionalThis method must be implemented if supportsQualifierSmartVault() is true.
MethodgetVaultLookupSession
Description

Gets the OsidSession associated with the vault lookup service.

Returnosid.authorization.VaultLookupSessiona VaultLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVaultLookup() is false
ComplianceoptionalThis method must be implemented if supportsVaultLookup() is true.
MethodgetVaultQuerySession
Description

Gets the OsidSession associated with the vault query service.

Returnosid.authorization.VaultQuerySessiona VaultQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVaultQuery() is false
ComplianceoptionalThis method must be implemented if supportsVaultQuery() is true.
MethodgetVaultSearchSession
Description

Gets the OsidSession associated with the vault search service.

Returnosid.authorization.VaultSearchSessiona VaultSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVaultSearch() is false
ComplianceoptionalThis method must be implemented if supportsVaultSearch() is true.
MethodgetVaultAdminSession
Description

Gets the OsidSession associated with the vault administration service.

Returnosid.authorization.VaultAdminSessiona VaultAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVaultAdmin() is false
ComplianceoptionalThis method must be implemented if supportsVaultAdmin() is true.
MethodgetVaultNotificationSession
Description

Gets the notification session for notifications pertaining to vault service changes.

Parametersosid.authorization.VaultReceivervaultreceiverthe vault receiver
Returnosid.authorization.VaultNotificationSessiona VaultNotificationSession
ErrorsNULL_ARGUMENT vaultReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVaultNotification() is false
ComplianceoptionalThis method must be implemented if supportsVaultNotification() is true.
MethodgetVaultHierarchySession
Description

Gets the session traversing vault hierarchies.

Returnosid.authorization.VaultHierarchySessiona VaultHierarchySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVaultHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsVaultHierarchy() is true.
MethodgetVaultHierarchyDesignSession
Description

Gets the session designing vault hierarchies.

Returnosid.authorization.VaultHierarchyDesignSessiona VaultHierarchyDesignSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVaultHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsVaultHierarchyDesign() is true.
MethodgetAuthorizationBatchManager
Description

Gets an AuthorizationBatchManager.

Returnosid.authorization.batch.AuthorizationBatchManageran AuthorizationBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationBatch() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationBatch() is true.
MethodgetAuthorizationRulesManager
Description

Gets an AuthorizationRulesManager.

Returnosid.authorization.rules.AuthorizationRulesManageran AuthorizationRulesManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationRules() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationRules() is true.