OSID Logo
OSID Specifications
relationship batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.batch.RelationshipBatchManager
Implementsosid.OsidManager
osid.relationship.batch.RelationshipBatchProfile
Description

The relationship batch manager provides access to relationship batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • RelationshipBatchAdminSession: a session to create, modify and delete Relationships in bulk
  • FamilyBatchAdminSession: a session to create, modify and delete Family in bulk
MethodgetRelationshipBatchAdminSession
Description

Gets the OsidSession associated with the bulk relationship administration service.

Returnosid.relationship.batch.RelationshipBatchAdminSessiona RelationshipBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipBatchAdmin() is true.
MethodgetRelationshipBatchAdminSessionForFamily
Description

Gets the OsidSession associated with the bulk relationship administration service for the given family.

Parametersosid.id.IdfamilyIdthe Id of the Family
Returnosid.relationship.batch.RelationshipBatchAdminSessiona RelationshipBatchAdminSession
ErrorsNOT_FOUNDno Family found by the given Id
NULL_ARGUMENT familyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipBatchAdmin() and supportsVisibleFederation() are true
MethodgetFamilyBatchAdminSession
Description

Gets the OsidSession associated with the bulk family administration service.

Returnosid.relationship.batch.FamilyBatchAdminSessiona FamilyBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFamilyBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsFamilyBatchAdmin() is true.