| Interface | osid.relationship.batch.RelationshipBatchManager | ||
|---|---|---|---|
| Implements | osid.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:
| ||
| Method | getRelationshipBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.relationship.batch.RelationshipBatchAdminSession | a RelationshipBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsRelationshipBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsRelationshipBatchAdmin()
is true. | |
| Method | getRelationshipBatchAdminSessionForFamily | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | familyId | the Id of the Family |
| Return | osid.relationship.batch.RelationshipBatchAdminSession | a RelationshipBatchAdminSession | |
| Errors | NOT_FOUND | no Family found by the given Id | |
| NULL_ARGUMENT | familyId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsRelationshipBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsRelationshipBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getFamilyBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.relationship.batch.FamilyBatchAdminSession | a FamilyBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsFamilyBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsFamilyBatchAdmin()
is true. | |