public interface FrontOfficeBatchAdminSession extends FrontOfficeAdminSession
This session creates, updates, and deletes FrontOffices
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
FrontOffice,
a FrontOfficeForm
is requested using
getFrontOfficeFormsForCreate()
specifying the desired
record Types
or none if no record Types
are
needed. Each of the returned FrontOfficeForms
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 FrontOfficeForm
is submiited to a create operation, it cannot be reused with
another create operation unless the first operation was unsuccessful. Each
FrontOfficeForm
corresponds to an attempted transaction.
The FrontOfficeForms
returned from
getFrontOfficeFormsForCreate()
may be linked to the originating
request through the peer Ids
of the FrontOfficeForm.
In the case where there may be duplicates, any
FrontOfficeForm
of the same peer Ids
may be used
for a create operation.
Once a batch of FrontOfficeForms
are submitted for
create, a CreateResponse
is returned for each
FrontOfficeForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createFrontOffice(),
errors specific to an individual
FrontOfficeForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating FrontOfficeForm
through the
FrontOfficeForm
Id
.
For updates, FrontOfficeForms
are requested to the
FrontOffice
Id
that is to be updated using
getFrontOfficeFormsForUpdate()
where the reference
Id
in the FrontOfficeForm
may be used to link the
request. Similarly, the FrontOfficeForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The FrontOfficeForm
can only be used
once for a successful update and cannot be reused.
Once a batch of FrontOfficeForms
are submitted for
update, an UpdateResponse
is returned for each
FrontOfficeForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateFrontOffice(),
errors specific to an individual
FrontOfficeForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating FrontOfficeForm
through the
FrontOfficeForm
Id.
The delete operations delete FrontOffices
in bulk. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasFrontOffices(AliasRequestList aliasRequests)
Adds an
Id to a FrontOffice for the
purpose of creating compatibility. |
CreateResponseList |
createFrontOffices(FrontOfficeBatchFormList frontOfficeForms)
Creates a new set of
FrontOffices. |
DeleteResponseList |
deleteAllFrontOffices()
Deletes all
FrontOffices. |
DeleteResponseList |
deleteFrontOffices(IdList frontOfficeIds)
Deletes front offices for the given
Ids. |
FrontOfficeBatchFormList |
getFrontOfficeFormsForCreate(long number,
Type[] frontOfficeRecordTypes)
Gets the front office forms for creating a bunch of new front offices.
|
FrontOfficeBatchFormList |
getFrontOfficeFormsForUpdate(IdList frontOfficeIds)
Gets the front office forms for updating an existing set of front
offices.
|
UpdateResponseList |
updateFrontOffices(FrontOfficeBatchFormList frontOfficeForms)
Updates existing front offices.
|
aliasFrontOffice, canCreateFrontOffices, canCreateFrontOfficeWithRecordTypes, canDeleteFrontOffices, canManageFrontOfficeAliases, canUpdateFrontOffices, createFrontOffice, deleteFrontOffice, getFrontOfficeFormForCreate, getFrontOfficeFormForUpdate, updateFrontOffice
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
FrontOfficeBatchFormList getFrontOfficeFormsForCreate(long number, Type[] frontOfficeRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievefrontOfficeRecordTypes
- array of front office record types to
be included in each create operation or an empty list if noneNullArgumentException
- frontOfficeRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createFrontOffices(FrontOfficeBatchFormList frontOfficeForms) throws OperationFailedException, PermissionDeniedException
FrontOffices.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.frontOfficeForms
- the front office formsNullArgumentException
- frontOfficeForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FrontOfficeBatchFormList getFrontOfficeFormsForUpdate(IdList frontOfficeIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
frontOfficeIds
- the Ids
of the
FrontOffices
NotFoundException
- a frontOfficeId
is
not foundNullArgumentException
- frontOfficeIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateFrontOffices(FrontOfficeBatchFormList frontOfficeForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.frontOfficeForms
- the form containing the elements to be
updatedNullArgumentException
- frontOfficeForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllFrontOffices() throws OperationFailedException, PermissionDeniedException
FrontOffices.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteFrontOffices(IdList frontOfficeIds) throws OperationFailedException, PermissionDeniedException
Ids.
frontOfficeIds
- the Ids
of the front office to
deleteNullArgumentException
- frontOfficeIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasFrontOffices(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a FrontOffice
for the
purpose of creating compatibility. The primary Id
of
the FrontOffice
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another front office, it is reassigned to the
given entry Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.