org.osid.resourcing.batch

Interface AvailabilityBatchAdminSession

All Superinterfaces:

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

public interface AvailabilityBatchAdminSession
extends AvailabilityAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasAvailabilities(AliasRequestList aliasRequests) Adds an Id to an Availability for the purpose of creating compatibility.
CreateResponseList	createAvailabilities(AvailabilityBatchFormList availabilityForms) Creates a new set of Availabilities.
DeleteResponseList	deleteAllAvailabilities() Deletes all Availabilities in this Foundry .
DeleteResponseList	deleteAvailabilities(IdList availabilityIds) Deletes availabilities for the given Ids.
DeleteResponseList	deleteAvailabilitiesForJob(Id jobId) Deletes all availabilities for the given job.
DeleteResponseList	deleteAvailabilitiesForResource(Id resourceId) Deletes all availabilities for the given resource.
DeleteResponseList	deleteIneffectiveAvailabilitiesByDate(DateTime date) Deletes availabilities expired before the given date.
AvailabilityBatchFormList	getAvailabilityFormsForCreate(AvailabilityPeerList peers, Type[] availabilityRecordTypes) Gets the availability forms for creating a bunch of new availabilities.
AvailabilityBatchFormList	getAvailabilityFormsForUpdate(IdList availabilityIds) Gets the availability forms for updating an existing set of availabilities.
UpdateResponseList	updateAvailabilities(AvailabilityBatchFormList availabilityForms) Updates existing availabilities.

Methods inherited from interface org.osid.resourcing.AvailabilityAdminSession

aliasAvailability, canCreateAvailabilities, canCreateAvailabilityWithRecordTypes, canDeleteAvailabilities, canManageAvailabilityAliases, canUpdateAvailabilities, createAvailability, deleteAvailability, getAvailabilityFormForCreate, getAvailabilityFormForUpdate, getFoundry, getFoundryId, updateAvailability

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

getAvailabilityFormsForCreate

AvailabilityBatchFormList getAvailabilityFormsForCreate(AvailabilityPeerList peers,
                                                      Type[] availabilityRecordTypes)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

peers - the relationship peers

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

Returns:

the availability forms

Throws:

NotFoundException - an effortId or resourceId is not found

NullArgumentException - peers or availabilityRecordTypes 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.

createAvailabilities

CreateResponseList createAvailabilities(AvailabilityBatchFormList availabilityForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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 .

Parameters:

availabilityForms - the availability forms

Returns:

the create responses

Throws:

NullArgumentException - availabilityForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAvailabilityFormsForUpdate

AvailabilityBatchFormList getAvailabilityFormsForUpdate(IdList availabilityIds)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

availabilityIds - the Ids of the Availability

Returns:

the availability form

Throws:

NotFoundException - an availabilityId is not found

NullArgumentException - availabilityIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAvailabilities

UpdateResponseList updateAvailabilities(AvailabilityBatchFormList availabilityForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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 .

Parameters:

availabilityForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - availabilityForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllAvailabilities

DeleteResponseList deleteAllAvailabilities()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes all Availabilities in this Foundry .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAvailabilities

DeleteResponseList deleteAvailabilities(IdList availabilityIds)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes availabilities for the given Ids.

Parameters:

availabilityIds - the Ids of the availabilities to delete

Returns:

the delete responses

Throws:

NullArgumentException - availabilityIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAvailabilitiesForResource

DeleteResponseList deleteAvailabilitiesForResource(Id resourceId)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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

deleteAvailabilitiesForJob

DeleteResponseList deleteAvailabilitiesForJob(Id jobId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Deletes all availabilities for the given job.

Parameters:

jobId - an Id of a job

Returns:

the delete responses

Throws:

NullArgumentException - jobId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveAvailabilitiesByDate

DeleteResponseList deleteIneffectiveAvailabilitiesByDate(DateTime date)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

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

aliasAvailabilities

AliasResponseList aliasAvailabilities(AliasRequestList aliasRequests)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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.

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.