Interface TopologyBatchManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable, TopologyBatchProfile

public interface TopologyBatchManager
extends OsidManager, TopologyBatchProfile

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

• NodeBatchAdminSession : a session to create, modify and delete Nodes in bulk
• EdgeBatchAdminSession : a session to create, modify and delete Edges in bulk
• GraphBatchAdminSession : a session to create, modify and delete Graph in bulk

Method Summary

Modifier and Type	Method	Description
EdgeBatchAdminSession	getEdgeBatchAdminSession()	Gets the OsidSession associated with the bulk edge administration service.
EdgeBatchAdminSession	getEdgeBatchAdminSessionForGraph(Id graphId)	Gets the OsidSession associated with the bulk edge administration service for the given graph.
GraphBatchAdminSession	getGraphBatchAdminSession()	Gets the OsidSession associated with the bulk graph administration service.
NodeBatchAdminSession	getNodeBatchAdminSession()	Gets the OsidSession associated with the bulk node administration service.
NodeBatchAdminSession	getNodeBatchAdminSessionForGraph(Id graphId)	Gets the OsidSession associated with the bulk node administration service for the given graph.

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

Methods inherited from interface TopologyBatchProfile

supportsEdgeBatchAdmin, supportsGraphBatchAdmin, supportsNodeBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsEdgeBatchAdmin()	Tests if bulk administration of edges is available.
boolean	supportsGraphBatchAdmin()	Tests if bulk administration of graph is available.
boolean	supportsNodeBatchAdmin()	Tests if bulk administration of nodes is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Method Details

getNodeBatchAdminSession

NodeBatchAdminSession getNodeBatchAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the bulk node administration service.

Returns:

a NodeBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsNodeBatchAdmin()} is {@code true} .

getNodeBatchAdminSessionForGraph

NodeBatchAdminSession getNodeBatchAdminSessionForGraph(Id graphId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk node administration service for the given graph.

Parameters:

graphId - the Id of the Graph

Returns:

a NodeBatchAdminSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsNodeBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsNodeBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getEdgeBatchAdminSession

EdgeBatchAdminSession getEdgeBatchAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the bulk edge administration service.

Returns:

an EdgeBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsEdgeBatchAdmin()} is {@code true} .

getEdgeBatchAdminSessionForGraph

EdgeBatchAdminSession getEdgeBatchAdminSessionForGraph(Id graphId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk edge administration service for the given graph.

Parameters:

graphId - the Id of the Graph

Returns:

an EdgeBatchAdminSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsEdgeBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getGraphBatchAdminSession

GraphBatchAdminSession getGraphBatchAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk graph administration service.

Returns:

a GraphBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGraphBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsGraphBatchAdmin()} is {@code true} .