OSID Logo
OSID Specifications
relationship batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.batch.FamilyBatchAdminSession
Implementsosid.relationship.FamilyAdminSession
Description

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.

MethodgetFamilyFormsForCreate
Description

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

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

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 .

Parametersosid.relationship.batch.FamilyBatchFormListfamilyFormsthe family forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT familyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFamilyFormsForUpdate
Description

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

Parametersosid.id.IdListfamilyIdsthe Ids of the Families
Returnosid.relationship.batch.FamilyBatchFormListthe family form
ErrorsNOT_FOUNDa familyId is not found
NULL_ARGUMENT familyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateFamilies
Description

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 .

Parametersosid.relationship.batch.FamilyBatchFormListfamilyFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT familyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllFamilies
Description

Deletes all Families.

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

Deletes families for the given Ids.

Parametersosid.id.IdListfamilyIdsthe Ids of the families to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT familyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasFamilies
Description

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.

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.