OSID Logo
OSID Specifications
resourcing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.batch.AvailabilityBatchAdminSession
Implementsosid.resourcing.AvailabilityAdminSession
Description

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

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

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

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

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

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

MethodgetAvailabilityFormsForCreate
Description

Gets the availability forms for creating a bunch of new availabilities. An AvailabilityForm is returned for each job and resource pair.

Parametersosid.resourcing.batch.AvailabilityPeerListpeersthe relationship peers
osid.type.Type[]availabilityRecordTypesarray of availability record types to be included in each create operation or an empty list if none
Returnosid.resourcing.batch.AvailabilityBatchFormListthe availability forms
ErrorsNOT_FOUNDan effortId or resourceId is not found
NULL_ARGUMENT peers or availabilityRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateAvailabilities
Description

Creates a new set of Availabilities. 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.AvailabilityBatchFormListavailabilityFormsthe availability forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT availabilityForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityFormsForUpdate
Description

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

Parametersosid.id.IdListavailabilityIdsthe Ids of the Availability
Returnosid.resourcing.batch.AvailabilityBatchFormListthe availability form
ErrorsNOT_FOUNDan availabilityId is not found
NULL_ARGUMENT availabilityIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAvailabilities
Description

Updates existing availabilities. 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.AvailabilityBatchFormListavailabilityFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT availabilityForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllAvailabilities
Description

Deletes all Availabilities in this Foundry .

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

Deletes availabilities for the given Ids.

Parametersosid.id.IdListavailabilityIdsthe Ids of the availabilities to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT availabilityIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAvailabilitiesForResource
Description

Deletes all availabilities 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.
MethoddeleteAvailabilitiesForJob
Description

Deletes all availabilities for the given job.

Parametersosid.id.IdjobIdan Id of a job
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT jobId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveAvailabilitiesByDate
Description

Deletes availabilities 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.
MethodaliasAvailabilities
Description

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