OSID Logo
OSID Specifications
profile batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.batch.ProfileBatchAdminSession
Implementsosid.profile.ProfileAdminSession
Description

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.

MethodgetProfileFormsForCreate
Description

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

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

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 .

Parametersosid.profile.batch.ProfileBatchFormListprofileFormsthe profile forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT profileForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfileFormsForUpdate
Description

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

Parametersosid.id.IdListprofileIdsthe Ids of the Profile
Returnosid.profile.batch.ProfileBatchFormListthe profile form
ErrorsNOT_FOUNDa profileId is not found
NULL_ARGUMENT profileIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateProfiles
Description

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 .

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

Deletes all Profiles.

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

Deletes profiles for the given Ids.

Parametersosid.id.IdListprofileIdsthe Ids of the profiles to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT profileIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasProfiles
Description

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.

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.