org.osid.profile.batch

Interface ProfileItemBatchAdminSession

All Superinterfaces:

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

public interface ProfileItemBatchAdminSession
extends ProfileItemAdminSession

This session creates, updates, and deletes ProfileItems 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 ProfileItem, a ProfileItemForm is requested using getProfileItemFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned ProfileItemForms 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 ProfileItemForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ProfileItemForm corresponds to an attempted transaction.

The ProfileItemForms returned from getProfileItemFormsForCreate() may be linked to the originating request through the peer Ids of the ProfileItemForm. In the case where there may be duplicates, any ProfileItemForm of the same peer Ids may be used for a create operation.

Once a batch of ProfileItemForms are submitted for create, a CreateResponse is returned for each ProfileItemForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createProfileItems(), errors specific to an individual ProfileItemForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating ProfileItemForm through the ProfileItemForm Id .

For updates, ProfileItemForms are requested to the ProfileItem Id that is to be updated using getProfileItemFormsForUpdate() where the reference Id in the ProfileItemForm may be used to link the request. Similarly, the ProfileItemForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ProfileItemForm can only be used once for a successful update and cannot be reused.

Once a batch of ProfileItemForms are submitted for update, an UpdateResponse is returned for each ProfileItemForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateProfileItems(), errors specific to an individual ProfileItemForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating ProfileItemForm through the ProfileItemForm Id.

The delete operations delete ProfileItems in bulk. To unmap a ProfileItem from the current Profile, the ProfileItemProfileAssignmentSession should be used. These delete operations attempt to remove the ProfileItem itself thus removing it from all known Profile catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasProfileItems(AliasRequestList aliasRequests) Adds an Id to a ProfileItem for the purpose of creating compatibility.
CreateResponseList	createProfileItems(ProfileItemBatchFormList profileItemForms) Creates a new set of ProfileItems.
DeleteResponseList	deleteAllProfileItems() Deletes all ProfileItems in this Profile .
DeleteResponseList	deleteProfileItems(IdList profileItemIds) Deletes profile items for the given Ids.
ProfileItemBatchFormList	getProfileItemFormsForCreate(long number, Type[] profileItemRecordTypes) Gets the profile item forms for creating a bunch of new profile items.
ProfileItemBatchFormList	getProfileItemFormsForUpdate(IdList profileItemIds) Gets the profile item forms for updating an existing set of profile items.
UpdateResponseList	updateProfileItems(ProfileItemBatchFormList profileItemForms) Updates existing profile items.

Methods inherited from interface org.osid.profile.ProfileItemAdminSession

aliasProfileItem, canCreateProfileItems, canCreateProfileItemWithRecordTypes, canDeleteProfileItems, canManageProfileItemAliases, canUpdateProfileItems, createProfileItem, deleteProfileItem, getProfile, getProfileId, getProfileItemFormForCreate, getProfileItemFormForUpdate, updateProfileItem

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

getProfileItemFormsForCreate

ProfileItemBatchFormList getProfileItemFormsForCreate(long number,
                                                    Type[] profileItemRecordTypes)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets the profile item forms for creating a bunch of new profile items.

Parameters:

number - the number of forms to retrieve

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

Returns:

the profile item forms

Throws:

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

createProfileItems

CreateResponseList createProfileItems(ProfileItemBatchFormList profileItemForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

profileItemForms - the profile item forms

Returns:

the create responses

Throws:

NullArgumentException - profileItemForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileItemFormsForUpdate

ProfileItemBatchFormList getProfileItemFormsForUpdate(IdList profileItemIds)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

profileItemIds - the Ids of the ProfileItem

Returns:

the profile item form

Throws:

NotFoundException - a profileItemId is not found

NullArgumentException - profileItemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateProfileItems

UpdateResponseList updateProfileItems(ProfileItemBatchFormList profileItemForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

profileItemForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - profileItemForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllProfileItems

DeleteResponseList deleteAllProfileItems()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes all ProfileItems in this Profile .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProfileItems

DeleteResponseList deleteProfileItems(IdList profileItemIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes profile items for the given Ids.

Parameters:

profileItemIds - the Ids of the profile items to delete

Returns:

the delete responses

Throws:

NullArgumentException - profileItemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasProfileItems

AliasResponseList aliasProfileItems(AliasRequestList aliasRequests)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Adds an Id to a ProfileItem for the purpose of creating compatibility. The primary Id of the ProfileItem is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another profile item, it is reassigned to the given profile item 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.