Interface SequencingManager

All Superinterfaces:

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

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

Modifier and Type	Method	Description
TypeList	getAntimatroidRecordTypes()	Gets the supported Antimatroid record types.
TypeList	getAntimatroidSearchRecordTypes()	Gets the supported Antimatroid search record types.
TypeList	getChainRecordTypes()	Gets the supported Chain record types.
TypeList	getChainSearchRecordTypes()	Gets the supported Chain search types.
boolean	supportsAntimatroidAdmin()	Tests if antimatroid administrative service is supported.
boolean	supportsAntimatroidHierarchy()	Tests for the availability of an antimatroid hierarchy traversal service.
boolean	supportsAntimatroidHierarchyDesign()	Tests for the availability of an antimatroid hierarchy design service.
boolean	supportsAntimatroidLookup()	Tests if looking up antimatroids is supported.
boolean	supportsAntimatroidNotification()	Tests if an antimatroid notification service is supported.
boolean	supportsAntimatroidQuery()	Tests if querying antimatroids is supported.
boolean	supportsAntimatroidRecordType(Type antimatroidRecordType)	Tests if the given Antimatroid record type is supported.
boolean	supportsAntimatroidSearch()	Tests if searching antimatroids is supported.
boolean	supportsAntimatroidSearchRecordType(Type antimatroidSearchRecordType)	Tests if the given Antimatroid search record type is supported.
boolean	supportsChainAdmin()	Tests if chain administrative service is supported.
boolean	supportsChainAntimatroid()	Tests if a chain antimatroid lookup service is supported.
boolean	supportsChainAntimatroidAssignment()	Tests if a chain antimatroid assignment service is supported.
boolean	supportsChainLookup()	Tests if looking up chains is supported.
boolean	supportsChainNotification()	Tests if a chain notification service is supported.
boolean	supportsChainQuery()	Tests if querying chains is supported.
boolean	supportsChainRecordType(Type chainRecordType)	Tests if the given Chain record type is supported.
boolean	supportsChainSearch()	Tests if searching chains is supported.
boolean	supportsChainSearchRecordType(Type chainSearchRecordType)	Tests if the given Chain search type is supported.
boolean	supportsChainSmartAntimatroid()	Tests if a chain smart antimatroid service is supported.
boolean	supportsElementAdmin()	Tests if managing elements is supported.
boolean	supportsElementLookup()	Tests if looking up elements is supported.
boolean	supportsSequencing()	Tests if sequencing elements is supported.
boolean	supportsVisibleFederation()	Tests if any action group federation is exposed.

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

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 {@code supportsElementLookup()} is {@code 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 {@code supportsElementLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsElementAdmin()} is {@code 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 {@code supportsElementAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsSequencing()} is {@code 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 {@code supportsSequencing()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsChainLookup()} is {@code 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 {@code supportsChainLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsChainQuery()} is {@code 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 {@code supportsChainQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsChainSearch()} is {@code 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 {@code supportsChainSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsChainAdmin()} is {@code 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 {@code supportsChainAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsChainNotification()} is {@code 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 {@code supportsChainNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsChainAntimatroid()} is {@code 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 {@code supportsChainAntimatroidAssignment()} is {@code 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 {@code supportsChainSmartAntimatroid()} is {@code 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 {@code supportsAntimatroidLookup()} is {@code 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 {@code supportsAntimatroidQuery()} is {@code 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 {@code supportsAntimatroidSearch()} is {@code 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 {@code supportsAntimatroidAdmin()} is {@code 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 {@code supportsAntimatroidNotification()} is {@code 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 {@code supportsAntimatroidHierarchy()} is {@code 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 {@code supportsAntimatroidHierarchyDesign()} is {@code true} .