Interface | osid.authorization.QualifierAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
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 associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateQualifiers | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Qualifier creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateQualifierWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | qualifierRecordTypes | array of qualifier record types |
Return | boolean | true if Qualifier creation using the
specified Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | qualifierRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getQualifierFormForCreate | ||
Description |
Gets the qualifier form for creating new qualifiers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | qualifierRecordTypes | array of qualifier record types |
Return | osid.authorization.QualifierForm | the qualifier form | |
Errors | NULL_ARGUMENT | qualifierRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form with requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createQualifier | ||
Description |
Creates a new | ||
Parameters | osid.authorization.QualifierForm | qualifierForm | the form for this Qualifier |
Return | osid.authorization.Qualifier | the new Qualifier | |
Errors | ILLEGAL_STATE | qualifierForm already used for a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | qualifierForms is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | qualifierForm did not originate from
getQualifierFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateQualifiers | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Qualifier modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQualifierFormForUpdate | ||
Description |
Gets the qualifier form for updating an existing qualifier. A new qualifier form should be requested for each update transaction. | ||
Parameters | osid.id.Id | qualifierId | the Id of the Qualifier |
Return | osid.authorization.QualifierForm | the qualifier form | |
Errors | NOT_FOUND | qualifierId is not found | |
NULL_ARGUMENT | qualifierId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateQualifier | ||
Description |
Updates an existing qualifier. | ||
Parameters | osid.authorization.QualifierForm | qualifierForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | qualifierForm already used for an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | qualifierForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | qualifierForm did not originate from
getQualifierFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteQualifiers | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Qualifier deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteQualifier | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | qualifierId | the Id of the Qualifier to remove |
Errors | NOT_FOUND | qualifierId not found | |
NULL_ARGUMENT | qualifierId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageQualifierAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Qualifier aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasQualifier | ||
Description |
Adds an | ||
Parameters | osid.id.Id | qualifierId | the Id of a Qualifier |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | qualifierId not found | ||
NULL_ARGUMENT | qualifierId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |