org.osid.relationship.batch

Interface FamilyBatchAdminSession

All Superinterfaces:

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

public interface FamilyBatchAdminSession
extends FamilyAdminSession

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

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

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

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

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

The delete operations delete Families in bulk. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasFamilies(AliasRequestList aliasRequests) Adds an Id to a Family for the purpose of creating compatibility.
CreateResponseList	createFamilies(FamilyBatchFormList familyForms) Creates a new set of Families.
DeleteResponseList	deleteAllFamilies() Deletes all Families.
DeleteResponseList	deleteFamilies(IdList familyIds) Deletes families for the given Ids.
FamilyBatchFormList	getFamilyFormsForCreate(long number, Type[] familyRecordTypes) Gets the family forms for creating a bunch of new family.
FamilyBatchFormList	getFamilyFormsForUpdate(IdList familyIds) Gets the family forms for updating an existing set of families.
UpdateResponseList	updateFamilies(FamilyBatchFormList familyForms) Updates existing families.

Methods inherited from interface org.osid.relationship.FamilyAdminSession

aliasFamily, canCreateFamilies, canCreateFamilyWithRecordTypes, canDeleteFamilies, canManageFamilyAliases, canUpdateFamilies, createFamily, deleteFamily, getFamilyFormForCreate, getFamilyFormForUpdate, updateFamily

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

getFamilyFormsForCreate

FamilyBatchFormList getFamilyFormsForCreate(long number,
                                          Type[] familyRecordTypes)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets the family forms for creating a bunch of new family.

Parameters:

number - the number of forms to retrieve

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

Returns:

the family forms

Throws:

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

createFamilies

CreateResponseList createFamilies(FamilyBatchFormList familyForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

familyForms - the family forms

Returns:

the create responses

Throws:

NullArgumentException - familyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFamilyFormsForUpdate

FamilyBatchFormList getFamilyFormsForUpdate(IdList familyIds)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

familyIds - the Ids of the Families

Returns:

the family form

Throws:

NotFoundException - a familyId is not found

NullArgumentException - familyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateFamilies

UpdateResponseList updateFamilies(FamilyBatchFormList familyForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

familyForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - familyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllFamilies

DeleteResponseList deleteAllFamilies()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Families.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteFamilies

DeleteResponseList deleteFamilies(IdList familyIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes families for the given Ids.

Parameters:

familyIds - the Ids of the families to delete

Returns:

the delete responses

Throws:

NullArgumentException - familyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasFamilies

AliasResponseList aliasFamilies(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

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