org.osid.personnel.batch

Interface PositionBatchAdminSession

All Superinterfaces:

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

public interface PositionBatchAdminSession
extends PositionAdminSession

This session creates, updates, and deletes Positions 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 a Position, a PositionForm is requested using getPositionFormsForCreate() specifying the desired organization and record Types or none if no record Types are needed. Each of the returned PositionForms 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 a PositionForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each PositionForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Positions in bulk. To unmap a Position from the current Realm, the PositionRealmAssignmentSession should be used. These delete operations attempt to remove the Position itself thus removing it from all known Realm catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasPositions(AliasRequestList aliasRequests) Adds an Id to a Position for the purpose of creating compatibility.
CreateResponseList	createPositions(PositionBatchFormList positionForms) Creates a new set of Positions.
DeleteResponseList	deleteAllPositions() Deletes all Positions in this Realm .
DeleteResponseList	deleteIneffectivePositionsByDate(DateTime date) Deletes positions expired before the given date.
DeleteResponseList	deletePositions(IdList positionIds) Deletes positions for the given Ids.
DeleteResponseList	deletePositionsForOrganization(Id organizationId) Deletes positions for the given organiation.
PositionBatchFormList	getPositionFormsForCreate(IdList organizationIds, Type[] positionRecordTypes) Gets the position forms for creating a bunch of new positions.
PositionBatchFormList	getPositionFormsForUpdate(IdList positionIds) Gets the position forms for updating an existing set of positions.
UpdateResponseList	updatePositions(PositionBatchFormList positionForms) Updates existing positions.

Methods inherited from interface org.osid.personnel.PositionAdminSession

aliasPosition, canCreatePositions, canCreatePositionWithRecordTypes, canDeletePositions, canManagePositionAliases, canUpdatePositions, createPosition, deletePosition, getPositionFormForCreate, getPositionFormForUpdate, getRealm, getRealmId, updatePosition

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

getPositionFormsForCreate

PositionBatchFormList getPositionFormsForCreate(IdList organizationIds,
                                              Type[] positionRecordTypes)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the position forms for creating a bunch of new positions. A form is returned for each supplied organization.

Parameters:

organizationIds - a list of organization Ids

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

Returns:

the position forms

Throws:

NotFoundException - an organizationId is not found

NullArgumentException - organizationIds or positionRecordTypes 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.

createPositions

CreateResponseList createPositions(PositionBatchFormList positionForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

positionForms - the position forms

Returns:

the create responses

Throws:

NullArgumentException - positionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPositionFormsForUpdate

PositionBatchFormList getPositionFormsForUpdate(IdList positionIds)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

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

Parameters:

positionIds - the Ids of the Position

Returns:

the position form

Throws:

NotFoundException - a positionId is not found

NullArgumentException - positionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePositions

UpdateResponseList updatePositions(PositionBatchFormList positionForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Updates existing positions. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

positionForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - positionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllPositions

DeleteResponseList deleteAllPositions()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes all Positions in this Realm .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePositions

DeleteResponseList deletePositions(IdList positionIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes positions for the given Ids.

Parameters:

positionIds - the Ids of the positions to delete

Returns:

the delete responses

Throws:

NullArgumentException - positionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePositionsForOrganization

DeleteResponseList deletePositionsForOrganization(Id organizationId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Deletes positions for the given organiation.

Parameters:

organizationId - the Id of an organization

Returns:

the delete responses

Throws:

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectivePositionsByDate

DeleteResponseList deleteIneffectivePositionsByDate(DateTime date)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Deletes positions 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.

aliasPositions

AliasResponseList aliasPositions(AliasRequestList aliasRequests)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Adds an Id to a Position for the purpose of creating compatibility. The primary Id of the Position is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another position, it is reassigned to the given position 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.