Interface | osid.resourcing.batch.EffortBatchAdminSession | ||
---|---|---|---|
Implements | osid.resourcing.EffortAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getEffortFormsForCreate | ||
Description |
Gets the effort forms for creating a bunch of new efforts. A form is returned for each commission and resource pair. | ||
Parameters | osid.resourcing.batch.EffortPeerList | peers | the relationship peers |
osid.type.Type[] | effortRecordTypes | array of effort record types to be included in each create operation or an empty list if none | |
Return | osid.resourcing.batch.EffortBatchFormList | the effort forms | |
Errors | NOT_FOUND | a commissionId or resourceId is not found | |
NULL_ARGUMENT | peers or effortRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createEfforts | ||
Description |
Creates a new set of | ||
Parameters | osid.resourcing.batch.EffortBatchFormList | effortForms | the effort forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | effortForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEffortFormsForUpdate | ||
Description |
Gets the effort forms for updating an existing set of efforts. A new effort form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | effortIds | the Ids of the Effort |
Return | osid.resourcing.batch.EffortBatchFormList | the effort form | |
Errors | NOT_FOUND | an effortId is not found | |
NULL_ARGUMENT | effortIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateEfforts | ||
Description |
Updates existing efforts. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.resourcing.batch.EffortBatchFormList | effortForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | effortForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllEfforts | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteEfforts | ||
Description |
Deletes efforts for the given | ||
Parameters | osid.id.IdList | effortIds | the Ids of the efforts to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | effortIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteEffortsForResource | ||
Description |
Deletes efforts for the given resource. | ||
Parameters | osid.id.Id | resourceId | an Id of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteEffortsForCommission | ||
Description |
Deletes efforts for the given commission. | ||
Parameters | osid.id.Id | commissionId | an Id of a commission |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | commissionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveEffortsByDate | ||
Description |
Deletes efforts expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasEfforts | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |