Interface | osid.authorization.rules.AuthorizationEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes authorization enablers.
The data for create and update is provided via the | ||
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 | canCreateAuthorizationEnabler | ||
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 | ||
Return | boolean | false if AuthorizationEnabler creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAuthorizationEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | authorizationEnablerRecordTypes | array of authorization enabler record types |
Return | boolean | true if AuthorizationEnabler creation using
the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | authorizationEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationEnablerFormForCreate | ||
Description |
Gets the authorization enabler form for creating new authorization enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | authorizationEnablerRecordTypes | array of authorization enabler record types |
Return | osid.authorization.rules.AuthorizationEnablerForm | the authorization enabler form | |
Errors | NULL_ARGUMENT | authorizationEnablerRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createAuthorizationEnabler | ||
Description |
Creates a new | ||
Parameters | osid.authorization.rules.AuthorizationEnablerForm | authorizationEnablerForm | the form for this AuthorizationEnabler |
Return | osid.authorization.rules.AuthorizationEnabler | the new AuthorizationEnabler | |
Errors | ILLEGAL_STATE | authorizationEnablerForm already used in a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | authorizationEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | authorizationEnablerForm did not originate from
getAuthorizationEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAuthorizationEnablers | ||
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 | ||
Return | boolean | false if AuthorizationEnabler modification is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationEnablerFormForUpdate | ||
Description |
Gets the authorization enabler form for updating an existing authorization enabler. A new authorization enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | authorizationEnablerId | the Id of the AuthorizationEnabler |
Return | osid.authorization.rules.AuthorizationEnablerForm | the authorization enabler form | |
Errors | NOT_FOUND | authorizationEnablerId is not found | |
NULL_ARGUMENT | authorizationEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAuthorizationEnabler | ||
Description |
Updates an existing authorization enabler. | ||
Parameters | osid.authorization.rules.AuthorizationEnablerForm | authorizationEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | authorizationEnablerForm already used in an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | authorizationEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | authorizationEnablerForm did not originate from
getAuthorizationEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAuthorizationEnablers | ||
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 | ||
Return | boolean | false if AuthorizationEnabler deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteAuthorizationEnabler | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | authorizationEnablerId | the Id of the AuthorizationEnabler to remove |
Errors | NOT_FOUND | authorizationEnablerId not found | |
NULL_ARGUMENT | authorizationEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageAuthorizationEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if AuthorizationEnabler aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAuthorizationEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | authorizationEnablerId | the Id of an AuthorizationEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | authorizationEnablerId not found | ||
NULL_ARGUMENT | authorizationEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |