org.osid.resource.batch

Interface ResourceBatchManager

All Superinterfaces:

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

public interface ResourceBatchManager
extends OsidManager, ResourceBatchProfile

The resource batch manager provides access to resource batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• ResourceBatchAdminSession: a session to create, modify and delete Resources in bulk
• ResourceRelationshipBatchAdminSession: a session to create, modify and delete 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() Gets the OsidSession associated with the bulk bin administration service.
ResourceBatchAdminSession	getResourceBatchAdminSession() Gets the OsidSession associated with the bulk resource administration service.
ResourceBatchAdminSession	getResourceBatchAdminSessionForBin(Id binId) Gets the OsidSession associated with the bulk resource administration service for the given bin.
ResourceRelationshipBatchAdminSession	getResourceRelationshipBatchAdminSession() Gets the OsidSession associated with the bulk resource relationship administration service.
ResourceRelationshipBatchAdminSession	getResourceRelationshipBatchAdminSessionForBin(Id binId) Gets the OsidSession associated with the bulk resource relationship administration service for the given bin.

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

Gets the OsidSession associated with the bulk resource administration service.

Returns:

a ResourceBatchAdminSession

Throws:

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

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

Parameters:

binId - the Id of the Bin

Returns:

a ResourceBatchAdminSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId 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()
                                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk resource relationship administration service.

Returns:

a ResourceRelationshipBatchAdminSession

Throws:

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)
                                                                                     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

Returns:

a ResourceRelationshipBatchAdminSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the bulk bin administration service.

Returns:

a BinBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBinBatchAdmin() is false

Compliance:

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