org.osid.sequencing

Interface SequencingManager

All Superinterfaces:

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

public interface SequencingManager
extends OsidManager, SequencingProfile

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

• ElementLookupSession : a session for retrieving elements in a chain
• ElementAdminSession : a session for managing elements in a chain
• SequencingSession : a session for sequencing elements in a chain
• ChainLookupSession: a session to retrieve chains
• ChainQuerySession: a session to query for chains
• ChainSearchSession: a session to search for chains
• ChainAdminSession: a session to create and delete chains
• ChainNotificationSession: a session to receive notifications pertaining to chain changes
• ChainAntimatroidsSession: a session to look up chain antimatroids mappings
• ChainAntimatroidAssignmentSession: a session to manage chain to antimatroid mappings
• ChainSmartAntimatroidSession: a session to manage dynamic antimatroids of chains

• AntimatroidLookupSession: a session to retrieve antimatroids
• AntimatroidQuerySession: a session to search for antimatroids
• AntimatroidSearchSession: a session to search for antimatroids
• AntimatroidAdminSession: a session to create and delete antimatroids
• AntimatroidNotificationSession: a session to receive notifications pertaining to antimatroid changes
• AntimatroidHierarchySession: a session to traverse a hierarchy of antimatroid
• AntimatroidHierarchyDesignSession: a session to manage an antimatroid hierarchy

Method Summary

Methods

Modifier and Type	Method and Description
AntimatroidAdminSession	getAntimatroidAdminSession() Gets the OsidSession associated with the antimatroid administrative service.
AntimatroidHierarchyDesignSession	getAntimatroidHierarchyDesignSession() Gets the OsidSession associated with the antimatroid hierarchy design service.
AntimatroidHierarchySession	getAntimatroidHierarchySession() Gets the OsidSession associated with the antimatroid hierarchy service.
AntimatroidLookupSession	getAntimatroidLookupSession() Gets the OsidSession associated with the antimatroid lookup service.
AntimatroidNotificationSession	getAntimatroidNotificationSession(AntimatroidReceiver antimatroidReceiver) Gets the OsidSession associated with the antimatroid notification service.
AntimatroidQuerySession	getAntimatroidQuerySession() Gets the OsidSession associated with the antimatroid query service.
AntimatroidSearchSession	getAntimatroidSearchSession() Gets the OsidSession associated with the antimatroid search service.
ChainAdminSession	getChainAdminSession() Gets the OsidSession associated with the chain administration service.
ChainAdminSession	getChainAdminSessionForInput(Id antimatroidId) Gets the OsidSession associated with the chain administration service for the given antimatroid.
ChainAntimatroidAssignmentSession	getChainAntimatroidAssignmentSession() Gets the OsidSession associated with assigning chains to antimatroids.
ChainAntimatroidSession	getChainAntimatroidSession() Gets the OsidSession to lookup chain/antimatroid mappings.
ChainLookupSession	getChainLookupSession() Gets the OsidSession associated with the chain lookup service.
ChainLookupSession	getChainLookupSessionForAntimatroid(Id antimatroidId) Gets the OsidSession associated with the chain lookup service for the given antimatroid.
ChainNotificationSession	getChainNotificationSession(ChainReceiver chainReceiver) Gets the OsidSession associated with the chain notification service.
ChainNotificationSession	getChainNotificationSessionForAntimatroid(ChainReceiver chainReceiver, Id antimatroidId) Gets the OsidSession associated with the chain notification service for the given antimatroid.
ChainQuerySession	getChainQuerySession() Gets the OsidSession associated with the chain query service.
ChainQuerySession	getChainQuerySessionForAntimatroid(Id antimatroidId) Gets the OsidSession associated with the chain query service for the given antimatroid.
ChainSearchSession	getChainSearchSession() Gets the OsidSession associated with the chain search service.
ChainSearchSession	getChainSearchSessionForAntimatroid(Id antimatroidId) Gets the OsidSession associated with the chain search service for the given antimatroid.
ChainSmartAntimatroidSession	getChainSmartAntimatroidSession(Id antimatroidId) Gets the OsidSession to manage locatin smart antimatroids.
ElementAdminSession	getElementAdminSession() Gets the OsidSession associated with the element admin service.
ElementAdminSession	getElementAdminSessionForAntimatroid(Id antimatroidId) Gets the OsidSession associated with the element admin service for the given antimatroid.
ElementLookupSession	getElementLookupSession() Gets the OsidSession associated with the element lookup service.
ElementLookupSession	getElementLookupSessionForAntimatroid(Id antimatroidId) Gets the OsidSession associated with the element lookup service for the given antimatroid.
SequencingSession	getSequencingSession() Gets the OsidSession associated with the element sequencing service.
SequencingSession	getSequencingSessionForAntimatroid(Id antimatroidId) Gets the OsidSession associated with the element sequencing service for the given antimatroid.

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

getAntimatroidRecordTypes, getAntimatroidSearchRecordTypes, getChainRecordTypes, getChainSearchRecordTypes, supportsAntimatroidAdmin, supportsAntimatroidHierarchy, supportsAntimatroidHierarchyDesign, supportsAntimatroidLookup, supportsAntimatroidNotification, supportsAntimatroidQuery, supportsAntimatroidRecordType, supportsAntimatroidSearch, supportsAntimatroidSearchRecordType, supportsChainAdmin, supportsChainAntimatroid, supportsChainAntimatroidAssignment, supportsChainLookup, supportsChainNotification, supportsChainQuery, supportsChainRecordType, supportsChainSearch, supportsChainSearchRecordType, supportsChainSmartAntimatroid, supportsElementAdmin, supportsElementLookup, supportsSequencing, 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

getElementLookupSession

ElementLookupSession getElementLookupSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the element lookup service.

Returns:

an ElementLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsElementLookup() is false

Compliance:

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

getElementLookupSessionForAntimatroid

ElementLookupSession getElementLookupSessionForAntimatroid(Id antimatroidId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the element lookup service for the given antimatroid.

Parameters:

antimatroidId - the Id of the antimatroid

Returns:

an ElementLookupSession

Throws:

NotFoundException - no Antimatroid found by the given Id

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsElementLookup() or supportsVisibleFederation() is false

Compliance:

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

getElementAdminSession

ElementAdminSession getElementAdminSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the element admin service.

Returns:

an ElementAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsElementAdmin() is false

Compliance:

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

getElementAdminSessionForAntimatroid

ElementAdminSession getElementAdminSessionForAntimatroid(Id antimatroidId)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the element admin service for the given antimatroid.

Parameters:

antimatroidId - the Id of the antimatroid

Returns:

an ElementAdminSession

Throws:

NotFoundException - no Antimatroid found by the given Id

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsElementAdmin() or supportsVisibleFederation() is false

Compliance:

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

getSequencingSession

SequencingSession getSequencingSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the element sequencing service.

Returns:

a SequencingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequencingn() is false

Compliance:

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

getSequencingSessionForAntimatroid

SequencingSession getSequencingSessionForAntimatroid(Id antimatroidId)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the element sequencing service for the given antimatroid.

Parameters:

antimatroidId - the Id of the antimatroid

Returns:

a SequencingSession

Throws:

NotFoundException - no Antimatroid found by the given Id

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequencing() or supportsVisibleFederation() is false

Compliance:

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

getChainLookupSession

ChainLookupSession getChainLookupSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the chain lookup service.

Returns:

a ChainLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChainLookup() is false

Compliance:

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

getChainLookupSessionForAntimatroid

ChainLookupSession getChainLookupSessionForAntimatroid(Id antimatroidId)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the chain lookup service for the given antimatroid.

Parameters:

antimatroidId - the Id of the antimatroid

Returns:

a ChainLookupSession

Throws:

NotFoundException - no Antimatroid found by the given Id

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChainLookup() or supportsVisibleFederation() is false

Compliance:

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

getChainQuerySession

ChainQuerySession getChainQuerySession()
                                       throws OperationFailedException

Gets the OsidSession associated with the chain query service.

Returns:

a ChainQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChainQuery() is false

Compliance:

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

getChainQuerySessionForAntimatroid

ChainQuerySession getChainQuerySessionForAntimatroid(Id antimatroidId)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the chain query service for the given antimatroid.

Parameters:

antimatroidId - the Id of the Antimatroid

Returns:

a ChainQuerySession

Throws:

NotFoundException - no antimatroid found by the given Id

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChainQuery() or supportsVisibleFederation() is false

Compliance:

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

getChainSearchSession

ChainSearchSession getChainSearchSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the chain search service.

Returns:

a ChainSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChainSearch() is false

Compliance:

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

getChainSearchSessionForAntimatroid

ChainSearchSession getChainSearchSessionForAntimatroid(Id antimatroidId)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the chain search service for the given antimatroid.

Parameters:

antimatroidId - the Id of the Antimatroid

Returns:

a ChainSearchSession

Throws:

NotFoundException - no antimatroid found by the given Id

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChainSearch() or supportsVisibleFederation() is false

Compliance:

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

getChainAdminSession

ChainAdminSession getChainAdminSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the chain administration service.

Returns:

a ChainAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChainAdmin() is false

Compliance:

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

getChainAdminSessionForInput

ChainAdminSession getChainAdminSessionForInput(Id antimatroidId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the chain administration service for the given antimatroid.

Parameters:

antimatroidId - the Id of the Dostributor

Returns:

a ChainAdminSession

Throws:

NotFoundException - no antimatroid found by the given Id

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChainAdmin() or supportsVisibleFederation() is false

Compliance:

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

getChainNotificationSession

ChainNotificationSession getChainNotificationSession(ChainReceiver chainReceiver)
                                                     throws OperationFailedException

Gets the OsidSession associated with the chain notification service.

Parameters:

chainReceiver - the notification callback

Returns:

a ChainNotificationSession

Throws:

NullArgumentException - chainReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChainNotification() is false

Compliance:

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

getChainNotificationSessionForAntimatroid

ChainNotificationSession getChainNotificationSessionForAntimatroid(ChainReceiver chainReceiver,
                                                                 Id antimatroidId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession associated with the chain notification service for the given antimatroid.

Parameters:

chainReceiver - the notification callback

antimatroidId - the Id of the Antimatroid

Returns:

a ChainNotificationSession

Throws:

NotFoundException - no antimatroid found by the given Id

NullArgumentException - chainReceiver or antimatroidId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChainNotification() or supportsVisibleFederation() is false

Compliance:

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

getChainAntimatroidSession

ChainAntimatroidSession getChainAntimatroidSession()
                                                   throws OperationFailedException

Gets the OsidSession to lookup chain/antimatroid mappings.

Returns:

a ChainAntimatroidSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChainAntimatroid() is false

Compliance:

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

getChainAntimatroidAssignmentSession

ChainAntimatroidAssignmentSession getChainAntimatroidAssignmentSession()
                                                                       throws OperationFailedException

Gets the OsidSession associated with assigning chains to antimatroids.

Returns:

a ChainAntimatroidAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsChainAntimatroidAssignment() is false

Compliance:

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

getChainSmartAntimatroidSession

ChainSmartAntimatroidSession getChainSmartAntimatroidSession(Id antimatroidId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession to manage locatin smart antimatroids.

Parameters:

antimatroidId - the Id of the Antimatroid

Returns:

a ChainSmartAntimatroidSession

Throws:

NotFoundException - no antimatroid found by the given Id

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChainSmartAntimatroid() is false

Compliance:

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

getAntimatroidLookupSession

AntimatroidLookupSession getAntimatroidLookupSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the antimatroid lookup service.

Returns:

a AntimatroidLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAntimatroidLookup() is false

Compliance:

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

getAntimatroidQuerySession

AntimatroidQuerySession getAntimatroidQuerySession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the antimatroid query service.

Returns:

an AntimatroidQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAntimatroidQuery() is false

Compliance:

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

getAntimatroidSearchSession

AntimatroidSearchSession getAntimatroidSearchSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the antimatroid search service.

Returns:

an AntimatroidSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAntimatroidSearch() is false

Compliance:

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

getAntimatroidAdminSession

AntimatroidAdminSession getAntimatroidAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the antimatroid administrative service.

Returns:

an AntimatroidAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAntimatroidAdmin() is false

Compliance:

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

getAntimatroidNotificationSession

AntimatroidNotificationSession getAntimatroidNotificationSession(AntimatroidReceiver antimatroidReceiver)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the antimatroid notification service.

Parameters:

antimatroidReceiver - the notification callback

Returns:

an AntimatroidNotificationSession

Throws:

NullArgumentException - antimatroidReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAntimatroidNotification() is false

Compliance:

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

getAntimatroidHierarchySession

AntimatroidHierarchySession getAntimatroidHierarchySession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the antimatroid hierarchy service.

Returns:

an AntimatroidHierarchySession for antimatroids

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAntimatroidHierarchy() is false

Compliance:

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

getAntimatroidHierarchyDesignSession

AntimatroidHierarchyDesignSession getAntimatroidHierarchyDesignSession()
                                                                       throws OperationFailedException

Gets the OsidSession associated with the antimatroid hierarchy design service.

Returns:

an HierarchyDesignSession for antimatroids

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAntimatroidHierarchyDesign() is false

Compliance:

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