org.osid.profile.batch

Interface ProfileBatchAdminSession

All Superinterfaces:

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

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.profile.ProfileAdminSession

aliasProfile, canCreateProfiles, canCreateProfileWithRecordTypes, canDeleteProfiles, canManageProfileAliases, canUpdateProfiles, createProfile, deleteProfile, getProfileFormForCreate, getProfileFormForUpdate, updateProfile

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

getProfileFormsForCreate

ProfileBatchFormList getProfileFormsForCreate(long number,
                                            Type[] profileRecordTypes)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets the profile forms for creating a bunch of new profiles.

Parameters:

number - the number of forms to retrieve

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

Returns:

the profile forms

Throws:

NullArgumentException - profileRecordTypes 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.

createProfiles

CreateResponseList createProfiles(ProfileBatchFormList profileForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Creates a new set of Profiles. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

profileForms - the profile forms

Returns:

the create responses

Throws:

NullArgumentException - profileForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileFormsForUpdate

ProfileBatchFormList getProfileFormsForUpdate(IdList profileIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

profileIds - the Ids of the Profile

Returns:

the profile form

Throws:

NotFoundException - a profileId is not found

NullArgumentException - profileIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateProfiles

UpdateResponseList updateProfiles(ProfileBatchFormList profileForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Updates existing profiles. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

profileForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - profileForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllProfiles

DeleteResponseList deleteAllProfiles()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Profiles.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProfiles

DeleteResponseList deleteProfiles(IdList profileIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes profiles for the given Ids.

Parameters:

profileIds - the Ids of the profiles to delete

Returns:

the delete responses

Throws:

NullArgumentException - profileIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasProfiles

AliasResponseList aliasProfiles(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

Adds an 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.

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.