org.osid.resourcing.batch

Interface EffortBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, EffortAdminSession, OsidSession

public interface EffortBatchAdminSession
extends EffortAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasEfforts(AliasRequestList aliasRequests) Adds an Id to an Effort for the purpose of creating compatibility.
CreateResponseList	createEfforts(EffortBatchFormList effortForms) Creates a new set of Efforts.
DeleteResponseList	deleteAllEfforts() Deletes all Efforts in this Foundry .
DeleteResponseList	deleteEfforts(IdList effortIds) Deletes efforts for the given Ids.
DeleteResponseList	deleteEffortsForCommission(Id commissionId) Deletes efforts for the given commission.
DeleteResponseList	deleteEffortsForResource(Id resourceId) Deletes efforts for the given resource.
DeleteResponseList	deleteIneffectiveEffortsByDate(DateTime date) Deletes efforts expired before the given date.
EffortBatchFormList	getEffortFormsForCreate(EffortPeerList peers, Type[] effortRecordTypes) Gets the effort forms for creating a bunch of new efforts.
EffortBatchFormList	getEffortFormsForUpdate(IdList effortIds) Gets the effort forms for updating an existing set of efforts.
UpdateResponseList	updateEfforts(EffortBatchFormList effortForms) Updates existing efforts.

Methods inherited from interface org.osid.resourcing.EffortAdminSession

aliasEffort, canCreateEfforts, canCreateEffortWithRecordTypes, canDeleteEfforts, canManageEffortAliases, canUpdateEfforts, createEffort, deleteEffort, getEffortFormForCreate, getEffortFormForUpdate, getFoundry, getFoundryId, updateEffort

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getEffortFormsForCreate

EffortBatchFormList getEffortFormsForCreate(EffortPeerList peers,
                                          Type[] effortRecordTypes)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

peers - the relationship peers

effortRecordTypes - array of effort record types to be included in each create operation or an empty list if none

Returns:

the effort forms

Throws:

NotFoundException - a commissionId or resourceId is not found

NullArgumentException - peers or effortRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createEfforts

CreateResponseList createEfforts(EffortBatchFormList effortForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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 .

Parameters:

effortForms - the effort forms

Returns:

the create responses

Throws:

NullArgumentException - effortForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortFormsForUpdate

EffortBatchFormList getEffortFormsForUpdate(IdList effortIds)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

effortIds - the Ids of the Effort

Returns:

the effort form

Throws:

NotFoundException - an effortId is not found

NullArgumentException - effortIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateEfforts

UpdateResponseList updateEfforts(EffortBatchFormList effortForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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 .

Parameters:

effortForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - effortForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllEfforts

DeleteResponseList deleteAllEfforts()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes all Efforts in this Foundry .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteEfforts

DeleteResponseList deleteEfforts(IdList effortIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes efforts for the given Ids.

Parameters:

effortIds - the Ids of the efforts to delete

Returns:

the delete responses

Throws:

NullArgumentException - effortIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteEffortsForResource

DeleteResponseList deleteEffortsForResource(Id resourceId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Deletes efforts for the given resource.

Parameters:

resourceId - an Id of a resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteEffortsForCommission

DeleteResponseList deleteEffortsForCommission(Id commissionId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Deletes efforts for the given commission.

Parameters:

commissionId - an Id of a commission

Returns:

the delete responses

Throws:

NullArgumentException - commissionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveEffortsByDate

DeleteResponseList deleteIneffectiveEffortsByDate(DateTime date)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Deletes efforts expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasEfforts

AliasResponseList aliasEfforts(AliasRequestList aliasRequests)
                               throws OperationFailedException,
                                      PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.