org.osid.profile.batch

Interface ProfileEntryBatchAdminSession

All Superinterfaces:

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

public interface ProfileEntryBatchAdminSession
extends ProfileEntryAdminSession

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

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

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

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

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

The delete operations delete ProfileEntries in bulk. To unmap a ProfileEntry from the current Profile, the ProfileEntryProfileAssignmentSession should be used. These delete operations attempt to remove the ProfileEntry 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	aliasProfileEntries(AliasRequestList aliasRequests) Adds an Id to a ProfileEntry for the purpose of creating compatibility.
CreateResponseList	createProfileEntries(ProfileEntryBatchFormList profileEntryForms) Creates a new set of ProfileEntries.
DeleteResponseList	deleteAllProfileEntries() Deletes all ProfileEntries in this Profile .
DeleteResponseList	deleteIneffectiveProfileEntriesByDate(DateTime date) Deletes profile entries expired before the given date.
DeleteResponseList	deleteProfileEntries(IdList profileEntryIds) Deletes profile entries for the given Ids.
DeleteResponseList	deleteProfileEntriesForProfileItem(Id profileItemId) Deletes profile entries for the given profile item.
DeleteResponseList	deleteProfileEntriesForResource(Id resourceId) Deletes profile entries for the given resource.
ProfileEntryBatchFormList	getProfileEntryFormsForCreateForAgents(ProfileEntryAgentPeerList peers, Type[] profileEntryRecordTypes) Gets the profile entry forms for creating a bunch of new profile entries.
ProfileEntryBatchFormList	getProfileEntryFormsForCreateForResources(ProfileEntryResourcePeerList peers, Type[] profileEntryRecordTypes) Gets the profile entry forms for creating a bunch of new profile entries.
ProfileEntryBatchFormList	getProfileEntryFormsForUpdate(IdList profileEntryIds) Gets the profile entry forms for updating an existing set of profile entries.
UpdateResponseList	updateProfileEntries(ProfileEntryBatchFormList profileEntryForms) Updates existing profile entries.

Methods inherited from interface org.osid.profile.ProfileEntryAdminSession

aliasProfileEntry, canCreateProfileEntries, canCreateProfileEntryWithRecordTypes, canDeleteProfileEntries, canManageProfileEntryAliases, canUpdateProfileEntries, createProfileEntry, deleteProfileEntry, getProfile, getProfileEntryFormForCreateForAgent, getProfileEntryFormForCreateForResource, getProfileEntryFormForUpdate, getProfileId, updateProfileEntry

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

getProfileEntryFormsForCreateForAgents

ProfileEntryBatchFormList getProfileEntryFormsForCreateForAgents(ProfileEntryAgentPeerList peers,
                                                               Type[] profileEntryRecordTypes)
                                                                 throws NotFoundException,
                                                                        OperationFailedException,
                                                                        PermissionDeniedException

Gets the profile entry forms for creating a bunch of new profile entries. A form is returned for each agent and profile item pair.

Parameters:

peers - the relationship peers

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

Returns:

the profile entry forms

Throws:

NotFoundException - an agentId or profileItemId is not found

NullArgumentException - peers or profileEntryRecordTypes 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.

getProfileEntryFormsForCreateForResources

ProfileEntryBatchFormList getProfileEntryFormsForCreateForResources(ProfileEntryResourcePeerList peers,
                                                                  Type[] profileEntryRecordTypes)
                                                                    throws NotFoundException,
                                                                           OperationFailedException,
                                                                           PermissionDeniedException

Gets the profile entry forms for creating a bunch of new profile entries. A form is returned for each resource and profile item pair.

Parameters:

peers - the relationship peers

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

Returns:

the profile entry forms

Throws:

NotFoundException - a resourceId or profileItemId is not found

NullArgumentException - peers or profileEntryRecordTypes 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.

createProfileEntries

CreateResponseList createProfileEntries(ProfileEntryBatchFormList profileEntryForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

profileEntryForms - the profile entry forms

Returns:

the create responses

Throws:

NullArgumentException - profileEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileEntryFormsForUpdate

ProfileEntryBatchFormList getProfileEntryFormsForUpdate(IdList profileEntryIds)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

profileEntryIds - the Ids of the ProfileEntry

Returns:

the profile entry form

Throws:

NotFoundException - a profileEntryId is not found

NullArgumentException - profileEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateProfileEntries

UpdateResponseList updateProfileEntries(ProfileEntryBatchFormList profileEntryForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

profileEntryForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - profileEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllProfileEntries

DeleteResponseList deleteAllProfileEntries()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes all ProfileEntries in this Profile .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProfileEntries

DeleteResponseList deleteProfileEntries(IdList profileEntryIds)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes profile entries for the given Ids.

Parameters:

profileEntryIds - the Ids of the profile entries to delete

Returns:

the delete responses

Throws:

NullArgumentException - profileEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProfileEntriesForProfileItem

DeleteResponseList deleteProfileEntriesForProfileItem(Id profileItemId)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Deletes profile entries for the given profile item.

Parameters:

profileItemId - the Id of a profile item

Returns:

the delete responses

Throws:

NullArgumentException - profileItemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProfileEntriesForResource

DeleteResponseList deleteProfileEntriesForResource(Id resourceId)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Deletes profile entries for the given resource.

Parameters:

resourceId - the Id of a resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveProfileEntriesByDate

DeleteResponseList deleteIneffectiveProfileEntriesByDate(DateTime date)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Deletes profile entries expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasProfileEntries

AliasResponseList aliasProfileEntries(AliasRequestList aliasRequests)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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