org.osid.relationship.batch

Interface RelationshipBatchProxyManager

All Superinterfaces:

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

public interface RelationshipBatchProxyManager
extends OsidProxyManager, RelationshipBatchProfile

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

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk relationship administration service.

Parameters:

proxy - a proxy

Returns:

a RelationshipBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                      Proxy proxy)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

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

Parameters:

familyId - the Id of the Family

proxy - a proxy

Returns:

a RelationshipBatchAdminSession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk family administration service.

Parameters:

proxy - a proxy

Returns:

a FamilyBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFamilyBatchAdmin() is false

Compliance:

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