OSID Logo
OSID Specifications
resourcing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.batch.EffortBatchAdminSession
Implementsosid.resourcing.EffortAdminSession
Description

This session creates, updates, and deletes Efforts in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create an Effort, an EffortForm is requested using getEffortFormsForCreate() specifying the desired commission, resource, record Types or none if no record Types are needed. Each of the returned EffortForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once an EffortForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each EffortForm corresponds to an attempted transaction.

The EffortForms returned from getEffortFormsForCreate() may be linked to the originating request through the peer Ids of the EffortForm. In the case where there may be duplicates, any EffortForm of the same peer Ids may be used for a create operation.

Once a batch of EffortForms are submitted for create, a CreateResponse is returned for each EffortForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createEfforts(), errors specific to an individual EffortForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating EffortForm through the EffortForm Id .

For updates, EffortForms are requested to the Effort Id that is to be updated using getEffortFormsForUpdate() where the reference Id in the EffortForm may be used to link the request. Similarly, the EffortForm has metadata about the data that can be updated and it can perform validation before submitting the update. The EffortForm can only be used once for a successful update and cannot be reused.

Once a batch of EffortForms are submitted for update, an UpdateResponse is returned for each EffortForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateEfforts(), errors specific to an individual EffortForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating EffortForm through the EffortForm Id.

The delete operations delete Efforts in bulk. To unmap an Effort from the current Foundry, the EffortFoundryAssignmentSession should be used. These delete operations attempt to remove the Effort itself thus removing it from all known Foundry catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetEffortFormsForCreate
Description

Gets the effort forms for creating a bunch of new efforts. A form is returned for each commission and resource pair.

Parametersosid.resourcing.batch.EffortPeerListpeersthe relationship peers
osid.type.Type[]effortRecordTypesarray of effort record types to be included in each create operation or an empty list if none
Returnosid.resourcing.batch.EffortBatchFormListthe effort forms
ErrorsNOT_FOUNDa commissionId or resourceId is not found
NULL_ARGUMENT peers or effortRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateEfforts
Description

Creates a new set of Efforts. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.resourcing.batch.EffortBatchFormListeffortFormsthe effort forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT effortForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEffortFormsForUpdate
Description

Gets the effort forms for updating an existing set of efforts. A new effort form should be requested for each update transaction.

Parametersosid.id.IdListeffortIdsthe Ids of the Effort
Returnosid.resourcing.batch.EffortBatchFormListthe effort form
ErrorsNOT_FOUNDan effortId is not found
NULL_ARGUMENT effortIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateEfforts
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 BatchCreateResponse .

Parametersosid.resourcing.batch.EffortBatchFormListeffortFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT effortForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllEfforts
Description

Deletes all Efforts in this Foundry .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteEfforts
Description

Deletes efforts for the given Ids.

Parametersosid.id.IdListeffortIdsthe Ids of the efforts to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT effortIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteEffortsForResource
Description

Deletes efforts for the given resource.

Parametersosid.id.IdresourceIdan Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteEffortsForCommission
Description

Deletes efforts for the given commission.

Parametersosid.id.IdcommissionIdan Id of a commission
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT commissionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveEffortsByDate
Description

Deletes efforts expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasEfforts
Description

Adds an Id to an Effort for the purpose of creating compatibility. The primary Id of the Effort is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another effort, it is reassigned to the given effort Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.