org.osid.sequencing

Interface SequencingProxyManager

All Superinterfaces:

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

public interface SequencingProxyManager
extends OsidProxyManager, SequencingProfile

The sequencing proxy manager provides access to sequencing sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. 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(Proxy proxy) Gets the OsidSession associated with the antimatroid administrative service.
AntimatroidHierarchyDesignSession	getAntimatroidHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the antimatroid hierarchy design service.
AntimatroidHierarchySession	getAntimatroidHierarchySession(Proxy proxy) Gets the OsidSession associated with the antimatroid hierarchy service.
AntimatroidLookupSession	getAntimatroidLookupSession(Proxy proxy) Gets the OsidSession associated with the antimatroid lookup service.
AntimatroidNotificationSession	getAntimatroidNotificationSession(AntimatroidReceiver antimatroidReceiver, Proxy proxy) Gets the OsidSession associated with the antimatroid notification service.
AntimatroidQuerySession	getAntimatroidQuerySession(Proxy proxy) Gets the OsidSession associated with the antimatroid query service.
AntimatroidSearchSession	getAntimatroidSearchSession(Proxy proxy) Gets the OsidSession associated with the antimatroid search service.
ChainAdminSession	getChainAdminSession(Proxy proxy) Gets the OsidSession associated with the chain administration service.
ChainAdminSession	getChainAdminSessionForInput(Id inputId, Proxy proxy) Gets the OsidSession associated with the chain administration service for the given input.
ChainAntimatroidAssignmentSession	getChainAntimatroidAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning chains to antimatroids.
ChainAntimatroidSession	getChainAntimatroidSession(Proxy proxy) Gets the OsidSession to lookup chain/antimatroid mappings.
ChainLookupSession	getChainLookupSession(Proxy proxy) Gets the OsidSession associated with the chain lookup service.
ChainLookupSession	getChainLookupSessionForAntimatroid(Id antimatroidId, Proxy proxy) Gets the OsidSession associated with the chain lookup service for the given antimatroid.
ChainNotificationSession	getChainNotificationSession(ChainReceiver chainReceiver, Proxy proxy) Gets the OsidSession associated with the chain notification service.
ChainNotificationSession	getChainNotificationSessionForAntimatroid(ChainReceiver chainReceiver, Id antimatroidId, Proxy proxy) Gets the OsidSession associated with the chain notification service for the given antimatroid.
ChainQuerySession	getChainQuerySession(Proxy proxy) Gets the OsidSession associated with the chain query service.
ChainQuerySession	getChainQuerySessionForAntimatroid(Id antimatroidId, Proxy proxy) Gets the OsidSession associated with the chain query service for the given antimatroid.
ChainSearchSession	getChainSearchSession(Proxy proxy) Gets the OsidSession associated with the chain search service.
ChainSearchSession	getChainSearchSessionForAntimatroid(Id antimatroidId, Proxy proxy) Gets the OsidSession associated with the chain search service for the given antimatroid.
ChainSmartAntimatroidSession	getChainSmartAntimatroidSession(Id antimatroidId, Proxy proxy) Gets the OsidSession to manage locatin smart antimatroids.
ElementAdminSession	getElementAdminSession(Proxy proxy) Gets the OsidSession associated with the element admin service.
ElementAdminSession	getElementAdminSessionForAntimatroid(Id antimatroidId, Proxy proxy) Gets the OsidSession associated with the element admin service for the given antimatroid.
ElementLookupSession	getElementLookupSession(Proxy proxy) Gets the OsidSession associated with the element lookup service.
ElementLookupSession	getElementLookupSessionForAntimatroid(Id antimatroidId, Proxy proxy) Gets the OsidSession associated with the element lookup service for the given antimatroid.
SequencingSession	getSequencingSession(Proxy proxy) Gets the OsidSession associated with the element sequencing service.
SequencingSession	getSequencingSessionForAntimatroid(Id antimatroidId, Proxy proxy) Gets the OsidSession associated with the element sequencing service for the given antimatroid.

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

Gets the OsidSession associated with the element lookup service.

Parameters:

proxy - a proxy

Returns:

an ElementLookupSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

antimatroidId - the Id of the antimatroid

proxy - a proxy

Returns:

an ElementLookupSession

Throws:

NotFoundException - no Antimatroid found by the given Id

NullArgumentException - antimatroidId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the element admin service.

Parameters:

proxy - a proxy

Returns:

an ElementAdminSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

antimatroidId - the Id of the antimatroid

proxy - a proxy

Returns:

an ElementAdminSession

Throws:

NotFoundException - no Antimatroid found by the given Id

NullArgumentException - antimatroidId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the element sequencing service.

Parameters:

proxy - a proxy

Returns:

a SequencingSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

antimatroidId - the Id of the antimatroid

proxy - a proxy

Returns:

a SequencingSession

Throws:

NotFoundException - no Antimatroid found by the given Id

NullArgumentException - antimatroidId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the chain lookup service.

Parameters:

proxy - a proxy

Returns:

a ChainLookupSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

antimatroidId - the Id of the antimatroid

proxy - a proxy

Returns:

a ChainLookupSession

Throws:

NotFoundException - no Antimatroid found by the given Id

NullArgumentException - antimatroidId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the chain query service.

Parameters:

proxy - a proxy

Returns:

a ChainQuerySession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

antimatroidId - the Id of the Antimatroid

proxy - a proxy

Returns:

a ChainQuerySession

Throws:

NotFoundException - no antimatroid found by the given Id

NullArgumentException - antimatroidId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the chain search service.

Parameters:

proxy - a proxy

Returns:

a ChainSearchSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

antimatroidId - the Id of the Antimatroid

proxy - a proxy

Returns:

a ChainSearchSession

Throws:

NotFoundException - no antimatroid found by the given Id

NullArgumentException - antimatroidId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the chain administration service.

Parameters:

proxy - a proxy

Returns:

a ChainAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChainAdmin() is false

Compliance:

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

getChainAdminSessionForInput

ChainAdminSession getChainAdminSessionForInput(Id inputId,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

inputId - the Id of the Input

proxy - a proxy

Returns:

a ChainAdminSession

Throws:

NotFoundException - no input found by the given Id

NullArgumentException - inputId or proxy 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,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the chain notification service.

Parameters:

chainReceiver - the notification callback

proxy - a proxy

Returns:

a ChainNotificationSession

Throws:

NullArgumentException - chainReceiver or proxy 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,
                                                                 Proxy proxy)
                                                                   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

proxy - a proxy

Returns:

a ChainNotificationSession

Throws:

NotFoundException - no antimatroid found by the given Id

NullArgumentException - chainReceiver, antimatroidId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession to lookup chain/antimatroid mappings.

Parameters:

proxy - a proxy

Returns:

a ChainAntimatroidSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsChainAntimatroid() is false

Compliance:

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

getChainAntimatroidAssignmentSession

ChainAntimatroidAssignmentSession getChainAntimatroidAssignmentSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with assigning chains to antimatroids.

Parameters:

proxy - a proxy

Returns:

a ChainAntimatroidAssignmentSession

Throws:

NullArgumentException - proxy is null

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

Gets the OsidSession to manage locatin smart antimatroids.

Parameters:

antimatroidId - the Id of the Antimatroid

proxy - a proxy

Returns:

a ChainSmartAntimatroidSession

Throws:

NotFoundException - no antimatroid found by the given Id

NullArgumentException - antimatroidId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the antimatroid lookup service.

Parameters:

proxy - a proxy

Returns:

an AntimatroidLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAntimatroidLookup() is false

Compliance:

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

getAntimatroidQuerySession

AntimatroidQuerySession getAntimatroidQuerySession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the antimatroid query service.

Parameters:

proxy - a proxy

Returns:

an AntimatroidQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAntimatroidQuery() is false

Compliance:

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

getAntimatroidSearchSession

AntimatroidSearchSession getAntimatroidSearchSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the antimatroid search service.

Parameters:

proxy - a proxy

Returns:

an AntimatroidSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAntimatroidSearch() is false

Compliance:

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

getAntimatroidAdminSession

AntimatroidAdminSession getAntimatroidAdminSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the antimatroid administrative service.

Parameters:

proxy - a proxy

Returns:

an AntimatroidAdminSession

Throws:

NullArgumentException - proxy is null

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

Gets the OsidSession associated with the antimatroid notification service.

Parameters:

antimatroidReceiver - the notification callback

proxy - a proxy

Returns:

an AntimatroidNotificationSession

Throws:

NullArgumentException - antimatroidReceiver or proxy 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(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the antimatroid hierarchy service.

Parameters:

proxy - a proxy

Returns:

an AntimatroidHierarchySession for antimatroids

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAntimatroidHierarchy() is false

Compliance:

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

getAntimatroidHierarchyDesignSession

AntimatroidHierarchyDesignSession getAntimatroidHierarchyDesignSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the antimatroid hierarchy design service.

Parameters:

proxy - a proxy

Returns:

an HierarchyDesignSession for antimatroids

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAntimatroidHierarchyDesign() is false

Compliance:

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