OSID Logo
OSID Specifications
relationship batch package
Version 3.1.0
Interfaceosid.relationship.batch.RelationshipBatchProxyManager
Implementsosid.OsidProxyManager
osid.relationship.batch.RelationshipBatchProfile
Used Byosid.relationship.RelationshipProxyManager
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. 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.Proxyproxy a proxy
Returnosid.relationship.batch.RelationshipBatchAdminSession a RelationshipBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRelationshipBatchAdmin() is false
Complianceoptional This 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.IdfamilyId the Id of the Family
osid.proxy.Proxyproxy a proxy
Returnosid.relationship.batch.RelationshipBatchAdminSession a RelationshipBatchAdminSession
ErrorsNOT_FOUND no Family found by the given Id
NULL_ARGUMENT familyId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRelationshipBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRelationshipBatchAdmin() and supportsVisibleFederation() are true
MethodgetFamilyBatchAdminSession
Description

Gets the OsidSession associated with the bulk family administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.relationship.batch.FamilyBatchAdminSession a FamilyBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFamilyBatchAdmin() is false
Complianceoptional This method must be implemented if supportsFamilyBatchAdmin() is true.