Interface | osid.hold.HoldAdminSession | ||
---|---|---|---|
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 | 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 | canCreateHolds | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Hold creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateHoldWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | holdRecordTypes | array of hold record types |
Return | boolean | true if Hold creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | holdRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldFormForCreateForResource | ||
Description |
Gets the hold form for creating new holds. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | issueId | the Id for the issue |
osid.id.Id | resourceId | the Id for the resource | |
osid.type.Type[] | holdRecordTypes | array of hold record types | |
Return | osid.hold.HoldForm | the hold form | |
Errors | NOT_FOUND | issueId or resourceId is not found | |
NULL_ARGUMENT | issueId, resourceId or holdRecordTypes 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 | getHoldFormForCreateForAgent | ||
Description |
Gets the hold form for creating new holds. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | issueId | the Id for the issue |
osid.id.Id | agentId | the Id for the agent | |
osid.type.Type[] | holdRecordTypes | array of hold record types | |
Return | osid.hold.HoldForm | the hold form | |
Errors | NOT_FOUND | issueId or agentId is not found | |
NULL_ARGUMENT | issueId, agentId or holdRecordTypes 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 | createHold | ||
Description |
Creates a new | ||
Parameters | osid.hold.HoldForm | holdForm | the form for this Hold |
Return | osid.hold.Hold | the new Hold | |
Errors | ILLEGAL_STATE | holdForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | holdForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | holdForm did not originate from
getHoldFormForCreateForResource() or
getHoldFormForCreateForAgent() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateHolds | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Hold modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldFormForUpdate | ||
Description |
Gets the hold form for updating an existing hold. A new hold form should be requested for each update transaction. | ||
Parameters | osid.id.Id | holdId | the Id of the Hold |
Return | osid.hold.HoldForm | the hold form | |
Errors | NOT_FOUND | holdId is not found | |
NULL_ARGUMENT | holdId is null | ||
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateHold | ||
Description |
Updates an existing hold. | ||
Parameters | osid.hold.HoldForm | holdForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | holdForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | holdId or holdForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | holdForm did not originate from
getHoldFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteHolds | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Hold deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteHold | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | holdId | the Id of the Hold to remove |
Errors | NOT_FOUND | holdId not found | |
NULL_ARGUMENT | holdId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageHoldAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Hold aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasHold | ||
Description |
Adds an | ||
Parameters | osid.id.Id | holdId | the Id of a Hold |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | holdId not found | ||
NULL_ARGUMENT | holdId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |