org.osid.relationship.batch

Interface RelationshipBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, RelationshipBatchProfile, Sourceable

public interface RelationshipBatchManager
extends OsidManager, RelationshipBatchProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
FamilyBatchAdminSession	getFamilyBatchAdminSession() Gets the OsidSession associated with the bulk family administration service.
RelationshipBatchAdminSession	getRelationshipBatchAdminSession() Gets the OsidSession associated with the bulk relationship administration service.
RelationshipBatchAdminSession	getRelationshipBatchAdminSessionForFamily(Id familyId) Gets the OsidSession associated with the bulk relationship administration service for the given family.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.relationship.batch.RelationshipBatchProfile

supportsFamilyBatchAdmin, supportsRelationshipBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getRelationshipBatchAdminSession

RelationshipBatchAdminSession getRelationshipBatchAdminSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk relationship administration service.

Returns:

a RelationshipBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsRelationshipBatchAdmin() is true.

getRelationshipBatchAdminSessionForFamily

RelationshipBatchAdminSession getRelationshipBatchAdminSessionForFamily(Id familyId)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

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

Parameters:

familyId - the Id of the Family

Returns:

a RelationshipBatchAdminSession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRelationshipBatchAdmin() and supportsVisibleFederation() are true

getFamilyBatchAdminSession

FamilyBatchAdminSession getFamilyBatchAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk family administration service.

Returns:

a FamilyBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFamilyBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsFamilyBatchAdmin() is true.