OSID Logo
OSID Specifications
personnel batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.batch.PositionBatchAdminSession
Implementsosid.personnel.PositionAdminSession
Description

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.

MethodgetPositionFormsForCreate
Description

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

Parametersosid.id.IdListorganizationIdsa list of organization Ids
osid.type.Type[]positionRecordTypesarray of position record types to be included in each create operation or an empty list if none
Returnosid.personnel.batch.PositionBatchFormListthe position forms
ErrorsNOT_FOUNDan organizationId is not found
NULL_ARGUMENT organizationIds or positionRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreatePositions
Description

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 .

Parametersosid.personnel.batch.PositionBatchFormListpositionFormsthe position forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT positionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPositionFormsForUpdate
Description

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

Parametersosid.id.IdListpositionIdsthe Ids of the Position
Returnosid.personnel.batch.PositionBatchFormListthe position form
ErrorsNOT_FOUNDa positionId is not found
NULL_ARGUMENT positionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePositions
Description

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 .

Parametersosid.personnel.batch.PositionBatchFormListpositionFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT positionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllPositions
Description

Deletes all Positions in this Realm .

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

Deletes positions for the given Ids.

Parametersosid.id.IdListpositionIdsthe Ids of the positions to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT positionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeletePositionsForOrganization
Description

Deletes positions for the given organiation.

Parametersosid.id.IdorganizationIdthe Id of an organization
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT organizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectivePositionsByDate
Description

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

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.

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.