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

This session provides methods to apply AuthorizationEnablers to Authorizations. An Authorization with multiple AuthorizationEnablers means any positive rule evaluation across the enablers result in an effective Authorization.

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.
MethodcanAssignAuthorizationEnablers
Description

Tests if this user can alter authorization enabler/authorization mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignAuthorizationEnablerToAuthorization
Description

Adds an existing AuthorizationEnabler to an Authorization.

Parametersosid.id.IdauthorizationEnablerIdthe Id of the AuthorizationEnabler
osid.id.IdauthorizationIdthe Id of the Authorization
ErrorsALREADY_EXISTS authorizationEnablerId already assigned to authorizationId
NOT_FOUND authorizationEnablerId or authorizationId not found
NULL_ARGUMENT authorizationEnablerId or authorizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignAuthorizationEnablerFromAuthorization
Description

Removes an AuthorizationEnabler from an Authorization.

Parametersosid.id.IdauthorizationEnablerIdthe Id of the AuthorizationEnabler
osid.id.IdauthorizationIdthe Id of the Authorization
ErrorsNOT_FOUND authorizationEnablerId or authorizationId not found or not mapped
NULL_ARGUMENT authorizationEnablerId or authorizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceAuthorizationEnablers
Description

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

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

Reorders authorization enablers for an authorization by moving the specified authorization enabler in front of a reference authorization enabler.

Parametersosid.id.IdauthorizationEnablerIdthe Id of an AuthorizationEnabler
osid.id.IdauthorizationIdthe Id of an Authorization
osid.id.IdreferenceIdthe reference authorization enabler Id
ErrorsNOT_FOUND authorizationEnablerId, authorizationId, or referenceId not found or, authorizationEnablerId or referenceId not related to authorizationId
NULL_ARGUMENT authorizationEnablerId, authorizationId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveAuthorizationEnablerBehind
Description

Reorders authorization enablers for an authorization by moving the specified authorization enabler behind a reference authorization enabler.

Parametersosid.id.IdauthorizationEnablerIdthe Id of an AuthorizationEnabler
osid.id.IdauthorizationIdthe Id of an Authorization
osid.id.IdreferenceIdthe reference authorization enabler Id
ErrorsNOT_FOUND authorizationEnabelrId, authorizationId, or referenceId not found or, authorizationEnablerId or referenceId not related to authorizationId
NULL_ARGUMENT authorizationEnablerId, authorizationId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderAuthorizationEnablers
Description

Reorders a set of authorization enablers for an authorization.

Parametersosid.id.Id[]authorizationEnablerIdsthe Ids for a set of AuthorizationEnablers
osid.id.IdauthorizationIdthe Id of an Authorization
ErrorsNOT_FOUND authorizationId not found or, an authorizationEnablerId not related to authorizationId
NULL_ARGUMENT authorizationEnablerIds or authorizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.