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

The relationship batch proxy manager provides access to relationship batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

  • RelationshipBatchAdminSession: a session to manage relationshipd 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.relationship.batch.RelationshipBatchAdminSessiona RelationshipBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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
osid.proxy.Proxyproxya proxy
Returnosid.relationship.batch.RelationshipBatchAdminSessiona RelationshipBatchAdminSession
ErrorsNOT_FOUNDno Family found by the given Id
NULL_ARGUMENT familyId or proxy 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.relationship.batch.FamilyBatchAdminSessiona FamilyBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFamilyBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsFamilyBatchAdmin() is true.