Interface ResourceBatchManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface ResourceBatchProfile

supportsBinBatchAdmin, supportsResourceBatchAdmin, supportsResourceRelationshipBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsBinBatchAdmin()	Tests if bulk administration of bins is available.
boolean	supportsResourceBatchAdmin()	Tests if bulk administration of resources is available.
boolean	supportsResourceRelationshipBatchAdmin()	Tests if bulk administration of resource relationships is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsResourceBatchAdmin()} is {@code 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 {@code supportsResourceBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsResourceRelationshipBatchAdmin()} is {@code 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 {@code supportsResourceRelationshipBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsBinBatchAdmin()} is {@code true} .