Interface | osid.authorization.rules.AuthorizationEnablerRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
Method | getVaultId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Vault Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getVault | ||
Description |
Gets the | ||
Return | osid.authorization.Vault | the vault | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAssignAuthorizationEnablers | ||
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 | ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | assignAuthorizationEnablerToAuthorization | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | authorizationEnablerId | the Id of the AuthorizationEnabler |
osid.id.Id | authorizationId | the Id of the Authorization | |
Errors | ALREADY_EXISTS | authorizationEnablerId already assigned to
authorizationId | |
NOT_FOUND | authorizationEnablerId or authorizationId not
found | ||
NULL_ARGUMENT | authorizationEnablerId or authorizationId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignAuthorizationEnablerFromAuthorization | ||
Description |
Removes an | ||
Parameters | osid.id.Id | authorizationEnablerId | the Id of the AuthorizationEnabler |
osid.id.Id | authorizationId | the Id of the Authorization | |
Errors | NOT_FOUND | authorizationEnablerId or authorizationId not
found or not mapped | |
NULL_ARGUMENT | authorizationEnablerId or authorizationId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceAuthorizationEnablers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if AuthorizationEnabler ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveAuthorizationEnablerAhead | ||
Description |
Reorders authorization enablers for an authorization by moving the specified authorization enabler in front of a reference authorization enabler. | ||
Parameters | osid.id.Id | authorizationEnablerId | the Id of an AuthorizationEnabler |
osid.id.Id | authorizationId | the Id of an Authorization | |
osid.id.Id | referenceId | the reference authorization enabler Id | |
Errors | NOT_FOUND | authorizationEnablerId, authorizationId, or
referenceId not found or, authorizationEnablerId or
referenceId not related to authorizationId | |
NULL_ARGUMENT | authorizationEnablerId, authorizationId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveAuthorizationEnablerBehind | ||
Description |
Reorders authorization enablers for an authorization by moving the specified authorization enabler behind a reference authorization enabler. | ||
Parameters | osid.id.Id | authorizationEnablerId | the Id of an AuthorizationEnabler |
osid.id.Id | authorizationId | the Id of an Authorization | |
osid.id.Id | referenceId | the reference authorization enabler Id | |
Errors | NOT_FOUND | authorizationEnabelrId, authorizationId, or
referenceId not found or, authorizationEnablerId or
referenceId not related to authorizationId | |
NULL_ARGUMENT | authorizationEnablerId, authorizationId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderAuthorizationEnablers | ||
Description |
Reorders a set of authorization enablers for an authorization. | ||
Parameters | osid.id.Id[] | authorizationEnablerIds | the Ids for a set of AuthorizationEnablers |
osid.id.Id | authorizationId | the Id of an Authorization | |
Errors | NOT_FOUND | authorizationId not found or, an
authorizationEnablerId not related to authorizationId | |
NULL_ARGUMENT | authorizationEnablerIds or authorizationId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |