OSID Logo
OSID Specifications
profile batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.batch.ProfileItemBatchAdminSession
Implementsosid.profile.ProfileItemAdminSession
Description

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.

MethodgetProfileItemFormsForCreate
Description

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

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]profileItemRecordTypesarray of profile item record types to be included in each create operation or an empty list if none
Returnosid.profile.batch.ProfileItemBatchFormListthe profile item forms
ErrorsNULL_ARGUMENT profileItemRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateProfileItems
Description

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 .

Parametersosid.profile.batch.ProfileItemBatchFormListprofileItemFormsthe profile item forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT profileItemForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfileItemFormsForUpdate
Description

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.

Parametersosid.id.IdListprofileItemIdsthe Ids of the ProfileItem
Returnosid.profile.batch.ProfileItemBatchFormListthe profile item form
ErrorsNOT_FOUNDa profileItemId is not found
NULL_ARGUMENT profileItemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateProfileItems
Description

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 .

Parametersosid.profile.batch.ProfileItemBatchFormListprofileItemFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT profileItemForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllProfileItems
Description

Deletes all ProfileItems in this Profile .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteProfileItems
Description

Deletes profile items for the given Ids.

Parametersosid.id.IdListprofileItemIdsthe Ids of the profile items to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT profileItemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasProfileItems
Description

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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.