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.
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.
|
aliasAvailability, canCreateAvailabilities, canCreateAvailabilityWithRecordTypes, canDeleteAvailabilities, canManageAvailabilityAliases, canUpdateAvailabilities, createAvailability, deleteAvailability, getAvailabilityFormForCreate, getAvailabilityFormForUpdate, getFoundry, getFoundryId, updateAvailability
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AvailabilityBatchFormList getAvailabilityFormsForCreate(AvailabilityPeerList peers, Type[] availabilityRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
AvailabilityForm
is returned for
each job and resource pair.peers
- the relationship peersavailabilityRecordTypes
- array of availability record types to
be included in each create operation or an empty list if noneNotFoundException
- an effortId
or
resourceId
is not foundNullArgumentException
- peers
or
availabilityRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createAvailabilities(AvailabilityBatchFormList availabilityForms) throws OperationFailedException, PermissionDeniedException
Availabilities.
This method
returns an error if the entire operation fails. Otherwise, the status
of an individual create operation is indicated in the
BatchCreateResponse
.availabilityForms
- the availability formsNullArgumentException
- availabilityForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityBatchFormList getAvailabilityFormsForUpdate(IdList availabilityIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
availabilityIds
- the Ids
of the
Availability
NotFoundException
- an availabilityId
is
not foundNullArgumentException
- availabilityIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateAvailabilities(AvailabilityBatchFormList availabilityForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.availabilityForms
- the form containing the elements to be
updatedNullArgumentException
- availabilityForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllAvailabilities() throws OperationFailedException, PermissionDeniedException
Availabilities
in this Foundry
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAvailabilities(IdList availabilityIds) throws OperationFailedException, PermissionDeniedException
Ids.
availabilityIds
- the Ids
of the availabilities
to deleteNullArgumentException
- availabilityIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAvailabilitiesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- an Id
of a resourceNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAvailabilitiesForJob(Id jobId) throws OperationFailedException, PermissionDeniedException
jobId
- an Id
of a jobNullArgumentException
- jobId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveAvailabilitiesByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasAvailabilities(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.