Interface | osid.resourcing.EffortAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
Method | getFoundryId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Foundry Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFoundry | ||
Description |
Gets the | ||
Return | osid.resourcing.Foundry | the foundry | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateEfforts | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Effort creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateEffortWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | effortRecordTypes | array of effort record types |
Return | boolean | true if Effort creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | effortRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getEffortFormForCreate | ||
Description |
Gets the effort form for creating new efforts. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | resourceId | the Id for the resource |
osid.id.Id | commissionId | the Id for the commission | |
osid.type.Type[] | effortRecordTypes | array of effort record types | |
Return | osid.resourcing.EffortForm | the effort form | |
Errors | NOT_FOUND | resourceId or commissionId is not found | |
NULL_ARGUMENT | resourceId, commissionId, or effortRecordTypes
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 | createEffort | ||
Description |
Creates a new | ||
Parameters | osid.resourcing.EffortForm | effortForm | the form for this Effort |
Return | osid.resourcing.Effort | the new Effort | |
Errors | ILLEGAL_STATE | effortForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | effortForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | effortForm did not originate from
getEffortFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateEfforts | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Effort modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEffortFormForUpdate | ||
Description |
Gets the effort form for updating an existing effort. A new effort form should be requested for each update transaction. | ||
Parameters | osid.id.Id | effortId | the Id of the Effort |
Return | osid.resourcing.EffortForm | the effort form | |
Errors | NOT_FOUND | effortId is not found | |
NULL_ARGUMENT | effortId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateEffort | ||
Description |
Updates an existing effort. | ||
Parameters | osid.resourcing.EffortForm | effortForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | effortForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | effortForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | effortForm did not originate from
getEffortFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteEfforts | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Effort deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteEffort | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | effortId | the Id of the Effort to remove |
Errors | NOT_FOUND | effortId not found | |
NULL_ARGUMENT | effortId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageEffortAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Effort aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasEffort | ||
Description |
Adds an | ||
Parameters | osid.id.Id | effortId | the Id of an Effort |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | effortId not found | ||
NULL_ARGUMENT | effortId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |