org.osid.resource.batch

Interface ResourceBatchProxyManager

All Superinterfaces:

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

public interface ResourceBatchProxyManager
extends OsidProxyManager, ResourceBatchProfile

The resource batch proxy manager provides access to resource 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:

• ResourceBatchAdminSession: a session to manage resources in bulk
• ResourceRelationshipBatchAdminSession: a session to manage resource relationships in bulk
• BinBatchAdminSession: a session to create, modify and delete Bins in bulk

Method Summary

Methods

Modifier and Type	Method and Description
BinBatchAdminSession	getBinBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk bin administration service.
ResourceBatchAdminSession	getResourceBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk resource administration service.
ResourceBatchAdminSession	getResourceBatchAdminSessionForBin(Id binId, Proxy proxy) Gets the OsidSession associated with the bulk resource administration service for the given bin.
ResourceRelationshipBatchAdminSession	getResourceRelationshipBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk resource administration service.
ResourceRelationshipBatchAdminSession	getResourceRelationshipBatchAdminSessionForBin(Id binId, Proxy proxy) Gets the OsidSession associated with the bulk resource relationship administration service for the given bin.

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.resource.batch.ResourceBatchProfile

supportsBinBatchAdmin, supportsResourceBatchAdmin, supportsResourceRelationshipBatchAdmin, 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

getResourceBatchAdminSession

ResourceBatchAdminSession getResourceBatchAdminSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk resource administration service.

Parameters:

proxy - a proxy

Returns:

a ResourceBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceBatchAdmin() is false

Compliance:

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

getResourceBatchAdminSessionForBin

ResourceBatchAdminSession getResourceBatchAdminSessionForBin(Id binId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the bulk resource administration service for the given bin.

Parameters:

binId - the Id of the Bin

proxy - a proxy

Returns:

a ResourceBatchAdminSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getResourceRelationshipBatchAdminSession

ResourceRelationshipBatchAdminSession getResourceRelationshipBatchAdminSession(Proxy proxy)
                                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk resource administration service.

Parameters:

proxy - a proxy

Returns:

a ResourceRelationshipBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipBatchAdmin() is false

Compliance:

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

getResourceRelationshipBatchAdminSessionForBin

ResourceRelationshipBatchAdminSession getResourceRelationshipBatchAdminSessionForBin(Id binId,
                                                                                   Proxy proxy)
                                                                                     throws NotFoundException,
                                                                                            OperationFailedException

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

Parameters:

binId - the Id of the Bin

proxy - a proxy

Returns:

a ResourceRelationshipBatchAdminSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBinBatchAdminSession

BinBatchAdminSession getBinBatchAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the bulk bin administration service.

Parameters:

proxy - a proxy

Returns:

a BinBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBinBatchAdmin() is false

Compliance:

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