Interface | osid.hold.rules.HoldEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes hold enablers. The data
for create and update is provided via the | ||
Method | getOublietteId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Oubliette Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOubliette | ||
Description |
Gets the | ||
Return | osid.hold.Oubliette | the oubliette | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateHoldEnabler | ||
Description |
Tests if this user can create hold enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known creating a
| ||
Return | boolean | false if HoldEnabler creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateHoldEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | holdEnablerRecordTypes | array of hold enabler record types |
Return | boolean | true if HoldEnabler creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | holdEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablerFormForCreate | ||
Description |
Gets the hold enabler form for creating new hold enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | holdEnablerRecordTypes | array of hold enabler record types |
Return | osid.hold.rules.HoldEnablerForm | the hold enabler form | |
Errors | NULL_ARGUMENT | holdEnablerRecordTypes 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 | createHoldEnabler | ||
Description |
Creates a new | ||
Parameters | osid.hold.rules.HoldEnablerForm | holdEnablerForm | the form for this HoldEnabler |
Return | osid.hold.rules.HoldEnabler | the new HoldEnabler | |
Errors | ILLEGAL_STATE | holdEnablerForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | holdEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | holdEnablerForm did not originate from
getHoldEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateHoldEnablers | ||
Description |
Tests if this user can update hold enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known updating a
| ||
Return | boolean | false if HoldEnabler modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablerFormForUpdate | ||
Description |
Gets the hold enabler form for updating an existing hold enabler. A new hold enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | holdEnablerId | the Id of the HoldEnabler |
Return | osid.hold.rules.HoldEnablerForm | the hold enabler form | |
Errors | NOT_FOUND | holdEnablerId is not found | |
NULL_ARGUMENT | holdEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateHoldEnabler | ||
Description |
Updates an existing hold enabler. | ||
Parameters | osid.hold.rules.HoldEnablerForm | holdEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | holdEnablerForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | holdEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | holdEnablerForm did not originate from
getHoldEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteHoldEnablers | ||
Description |
Tests if this user can delete hold enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known deleting a
| ||
Return | boolean | false if HoldEnabler deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteHoldEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | holdEnablerId | the Id of the HoldEnabler to remove |
Errors | NOT_FOUND | holdEnablerId not found | |
NULL_ARGUMENT | holdEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageHoldEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if HoldEnabler aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasHoldEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | holdEnablerId | the Id of a HoldEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | holdEnablerId not found | ||
NULL_ARGUMENT | holdEnablerId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |