OSID Logo
OSID Specifications
authorization rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.rules.AuthorizationEnablerAdminSession
Implementsosid.OsidSession
Description

This session creates and removes authorization enablers. The data for create and update is provided via the AuthorizationEnablerForm.

MethodgetVaultId
Description

Gets the Vault Id associated with this session.

Returnosid.id.Idthe Vault Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetVault
Description

Gets the Vault associated with this session.

Returnosid.authorization.Vaultthe vault
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateAuthorizationEnabler
Description

Tests if this user can create authorization enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an AuthorizationEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if AuthorizationEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateAuthorizationEnablerWithRecordTypes
Description

Tests if this user can create a single AuthorizationEnabler using the desired record types. While AuthorizationRulesManager.getAuthorizationEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific AuthorizationEnabler. Providing an empty array tests if an AuthorizationEnabler can be created with no records.

Parametersosid.type.Type[]authorizationEnablerRecordTypesarray of authorization enabler record types
Returnboolean true if AuthorizationEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT authorizationEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationEnablerFormForCreate
Description

Gets the authorization enabler form for creating new authorization enablers. A new form should be requested for each create transaction.

Parametersosid.type.Type[]authorizationEnablerRecordTypesarray of authorization enabler record types
Returnosid.authorization.rules.AuthorizationEnablerFormthe authorization enabler form
ErrorsNULL_ARGUMENT authorizationEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateAuthorizationEnabler
Description

Creates a new AuthorizationEnabler.

Parametersosid.authorization.rules.AuthorizationEnablerFormauthorizationEnablerFormthe form for this AuthorizationEnabler
Returnosid.authorization.rules.AuthorizationEnablerthe new AuthorizationEnabler
ErrorsILLEGAL_STATE authorizationEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT authorizationEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED authorizationEnablerForm did not originate from getAuthorizationEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAuthorizationEnablers
Description

Tests if this user can update authorization enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an AuthorizationEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if AuthorizationEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationEnablerFormForUpdate
Description

Gets the authorization enabler form for updating an existing authorization enabler. A new authorization enabler form should be requested for each update transaction.

Parametersosid.id.IdauthorizationEnablerIdthe Id of the AuthorizationEnabler
Returnosid.authorization.rules.AuthorizationEnablerFormthe authorization enabler form
ErrorsNOT_FOUND authorizationEnablerId is not found
NULL_ARGUMENT authorizationEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAuthorizationEnabler
Description

Updates an existing authorization enabler.

Parametersosid.authorization.rules.AuthorizationEnablerFormauthorizationEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE authorizationEnablerForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT authorizationEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED authorizationEnablerForm did not originate from getAuthorizationEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteAuthorizationEnablers
Description

Tests if this user can delete authorization enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an AuthorizationEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if AuthorizationEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteAuthorizationEnabler
Description

Deletes an AuthorizationEnabler.

Parametersosid.id.IdauthorizationEnablerIdthe Id of the AuthorizationEnabler to remove
ErrorsNOT_FOUND authorizationEnablerId not found
NULL_ARGUMENT authorizationEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageAuthorizationEnablerAliases
Description

Tests if this user can manage Id aliases for authorization enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if AuthorizationEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasAuthorizationEnabler
Description

Adds an Id to an AuthorizationEnabler for the purpose of creating compatibility. The primary Id of the AuthorizationEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another authorization enabler. it is reassigned to the given authorization enabler Id.

Parametersosid.id.IdauthorizationEnablerIdthe Id of an AuthorizationEnabler
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND authorizationEnablerId not found
NULL_ARGUMENT authorizationEnablerId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.