public interface ProfileBatchAdminSession extends ProfileAdminSession
This session creates, updates, and deletes Profiles
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
Profile,
a ProfileForm
is requested using
getProfileFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed. Each
of the returned ProfileForms
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 ProfileForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
ProfileForm
corresponds to an attempted transaction.
The ProfileForms
returned from
getProfileFormsForCreate()
may be linked to the originating
request through the peer Ids
of the ProfileForm.
In the case where there may be duplicates, any ProfileForm
of the same peer Ids
may be used for a create
operation.
Once a batch of ProfileForms
are submitted for create,
a CreateResponse
is returned for each ProfileForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createProfiles(),
errors specific to an individual ProfileForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
ProfileForm
through the ProfileForm
Id
.
For updates, ProfileForms
are requested to the
Profile
Id
that is to be updated using
getProfileFormsForUpdate()
where the reference Id
in the ProfileForm
may be used to link the request.
Similarly, the ProfileForm
has metadata about the data that
can be updated and it can perform validation before submitting the update.
The ProfileForm
can only be used once for a successful
update and cannot be reused.
Once a batch of ProfileForms
are submitted for update,
an UpdateResponse
is returned for each ProfileForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateProfiles(),
errors specific to an individual ProfileForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating
ProfileForm
through the ProfileForm
Id.
The delete operations delete Profiles
in bulk. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasProfiles(AliasRequestList aliasRequests)
Adds an
Id to a Profile for the purpose
of creating compatibility. |
CreateResponseList |
createProfiles(ProfileBatchFormList profileForms)
Creates a new set of
Profiles. |
DeleteResponseList |
deleteAllProfiles()
Deletes all
Profiles. |
DeleteResponseList |
deleteProfiles(IdList profileIds)
Deletes profiles for the given
Ids. |
ProfileBatchFormList |
getProfileFormsForCreate(long number,
Type[] profileRecordTypes)
Gets the profile forms for creating a bunch of new profiles.
|
ProfileBatchFormList |
getProfileFormsForUpdate(IdList profileIds)
Gets the profile forms for updating an existing set of profiles.
|
UpdateResponseList |
updateProfiles(ProfileBatchFormList profileForms)
Updates existing profiles.
|
aliasProfile, canCreateProfiles, canCreateProfileWithRecordTypes, canDeleteProfiles, canManageProfileAliases, canUpdateProfiles, createProfile, deleteProfile, getProfileFormForCreate, getProfileFormForUpdate, updateProfile
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProfileBatchFormList getProfileFormsForCreate(long number, Type[] profileRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveprofileRecordTypes
- array of profile record types to be
included in each create operation or an empty list if noneNullArgumentException
- profileRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createProfiles(ProfileBatchFormList profileForms) throws OperationFailedException, PermissionDeniedException
Profiles.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.profileForms
- the profile formsNullArgumentException
- profileForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileBatchFormList getProfileFormsForUpdate(IdList profileIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
profileIds
- the Ids
of the Profile
NotFoundException
- a profileId
is not
foundNullArgumentException
- profileIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateProfiles(ProfileBatchFormList profileForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.profileForms
- the form containing the elements to be updatedNullArgumentException
- profileForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllProfiles() throws OperationFailedException, PermissionDeniedException
Profiles.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteProfiles(IdList profileIds) throws OperationFailedException, PermissionDeniedException
Ids.
profileIds
- the Ids
of the profiles to deleteNullArgumentException
- profileIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasProfiles(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Profile
for the purpose
of creating compatibility. The primary Id
of the
Profile
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is
a pointer to another profile, it is reassigned to the given profile
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.