public interface IdBatchAdminSession extends IdAdminSession
This session creates Ids in bulk. The data for create is
provided by the consumer via the form object. OsidForms are
requested for each create or update and may not be reused.
Create operations differ in their usage. To create an Id,
an IdForm is requested using
getIdFormsForCreate() specifying the desired reference, resource,
and record Types or none if no record Types
are needed. Each of the returned IdForms 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 IdForm
is submiited to a create operation, it cannot be reused with another
create operation unless the first operation was unsuccessful. Each
IdForm corresponds to an attempted transaction.
The IdForms returned from getIdFormsForCreate()
may be linked to the originating request through the peer
Ids of the IdForm.
Once a batch of IdForms are submitted for create, a
CreateResponse is returned for each IdForm,
although the ordering is not defined. Only errors that pertain to the
entire create operation are returned from createIds(),
errors specific to an individual IdForm are indicated in
the corresponding CreateResponse. CreateResponses
may be linked to the originating IdForm through the
IdForm Id .
| Modifier and Type | Method and Description |
|---|---|
AliasResponseList |
aliasIds(AliasRequestList aliasRequests)
Makes a set of
Ids known to this service equivalent
such that for each primary and equivalent Id in the
given array, calls to IdLookupSession.getId(equivalentId)
return the primaryId. |
CreateResponseList |
createIds(IdBatchFormList idForms)
Creates a new set of
Ids. |
IdBatchFormList |
getIdFormsForCreate(long number)
Gets the
Id forms for creating new Ids. |
aliasId, canAliasIds, canCreateIds, createId, getIdFormForCreate, removeAliasgetAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionscloseIdBatchFormList getIdFormsForCreate(long number) throws OperationFailedException, PermissionDeniedException
Id forms for creating new Ids. A new form
should be requested for each create transaction.number - ther number of forms to request Id formsOperationFailedException - unable to complete requestPermissionDeniedException - authorization failuremandatory - This method must be implemented. CreateResponseList createIds(IdBatchFormList idForms) throws OperationFailedException, PermissionDeniedException
Ids. This method returns an error
if the entire operation fails. Otherwise, the status of an individual
create operation is indicated in the BatchCreateResponse
.idForms - the Id formsNullArgumentException - idForms is
null OperationFailedException - unable to complete requestPermissionDeniedException - authorization failuremandatory - This method must be implemented. AliasResponseList aliasIds(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Ids known to this service equivalent
such that for each primary and equivalent Id in the
given array, calls to IdLookupSession.getId(equivalentId)
return the primaryId. aliasRequests - the alias requestsNullArgumentException - aliasRequests is
null OperationFailedException - unable to complete requestPermissionDeniedException - authorization failuremandatory - This method must be implemented.