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 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. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ElementLookupSession getElementLookupSession() throws OperationFailedException
OsidSession
associated with the element lookup
service. ElementLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsElementLookup()
is false
optional
- This method must be implemented if
supportsElementLookup()
is true.
ElementLookupSession getElementLookupSessionForAntimatroid(Id antimatroidId) throws NotFoundException, OperationFailedException
OsidSession
associated with the element lookup
service for the given antimatroid.antimatroidId
- the Id
of the antimatroid ElementLookupSession
NotFoundException
- no Antimatroid
found
by the given Id
NullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsElementLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsElementLookup()
and
supportsVisibleFederation()
are true
ElementAdminSession getElementAdminSession() throws OperationFailedException
OsidSession
associated with the element admin
service. ElementAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsElementAdmin()
is false
optional
- This method must be implemented if
supportsElementAdmin()
is true.
ElementAdminSession getElementAdminSessionForAntimatroid(Id antimatroidId) throws NotFoundException, OperationFailedException
OsidSession
associated with the element admin
service for the given antimatroid.antimatroidId
- the Id
of the antimatroid ElementAdminSession
NotFoundException
- no Antimatroid
found
by the given Id
NullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsElementAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsElementAdmin()
and
supportsVisibleFederation()
are true
SequencingSession getSequencingSession() throws OperationFailedException
OsidSession
associated with the element
sequencing service. SequencingSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSequencingn()
is false
optional
- This method must be implemented if
supportsSequencing()
is true.
SequencingSession getSequencingSessionForAntimatroid(Id antimatroidId) throws NotFoundException, OperationFailedException
OsidSession
associated with the element
sequencing service for the given antimatroid.antimatroidId
- the Id
of the antimatroid SequencingSession
NotFoundException
- no Antimatroid
found
by the given Id
NullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSequencing()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSequencing()
and
supportsVisibleFederation()
are true
ChainLookupSession getChainLookupSession() throws OperationFailedException
OsidSession
associated with the chain lookup
service. ChainLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsChainLookup()
is false
optional
- This method must be implemented if
supportsChainLookup()
is true.
ChainLookupSession getChainLookupSessionForAntimatroid(Id antimatroidId) throws NotFoundException, OperationFailedException
OsidSession
associated with the chain lookup
service for the given antimatroid.antimatroidId
- the Id
of the antimatroid ChainLookupSession
NotFoundException
- no Antimatroid
found
by the given Id
NullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsChainLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsChainLookup()
and
supportsVisibleFederation()
are true
ChainQuerySession getChainQuerySession() throws OperationFailedException
OsidSession
associated with the chain query
service. ChainQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsChainQuery()
is false
optional
- This method must be implemented if
supportsChainQuery()
is true.
ChainQuerySession getChainQuerySessionForAntimatroid(Id antimatroidId) throws NotFoundException, OperationFailedException
OsidSession
associated with the chain query
service for the given antimatroid.antimatroidId
- the Id
of the Antimatroid
ChainQuerySession
NotFoundException
- no antimatroid found by the given
Id
NullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsChainQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsChainQuery()
and
supportsVisibleFederation()
are true
ChainSearchSession getChainSearchSession() throws OperationFailedException
OsidSession
associated with the chain search
service. ChainSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsChainSearch()
is false
optional
- This method must be implemented if
supportsChainSearch()
is true.
ChainSearchSession getChainSearchSessionForAntimatroid(Id antimatroidId) throws NotFoundException, OperationFailedException
OsidSession
associated with the chain search
service for the given antimatroid.antimatroidId
- the Id
of the Antimatroid
ChainSearchSession
NotFoundException
- no antimatroid found by the given
Id
NullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsChainSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsChainSearch()
and
supportsVisibleFederation()
are true
ChainAdminSession getChainAdminSession() throws OperationFailedException
OsidSession
associated with the chain
administration service. ChainAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsChainAdmin()
is false
optional
- This method must be implemented if
supportsChainAdmin()
is true.
ChainAdminSession getChainAdminSessionForInput(Id antimatroidId) throws NotFoundException, OperationFailedException
OsidSession
associated with the chain
administration service for the given antimatroid.antimatroidId
- the Id
of the Dostributor
ChainAdminSession
NotFoundException
- no antimatroid found by the given
Id
NullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsChainAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsChainAdmin()
and
supportsVisibleFederation()
are true
ChainNotificationSession getChainNotificationSession(ChainReceiver chainReceiver) throws OperationFailedException
OsidSession
associated with the chain
notification service.chainReceiver
- the notification callback ChainNotificationSession
NullArgumentException
- chainReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsChainNotification()
is false
optional
- This method must be implemented if
supportsChainNotification()
is true.
ChainNotificationSession getChainNotificationSessionForAntimatroid(ChainReceiver chainReceiver, Id antimatroidId) throws NotFoundException, OperationFailedException
OsidSession
associated with the chain
notification service for the given antimatroid.chainReceiver
- the notification callbackantimatroidId
- the Id
of the Antimatroid
ChainNotificationSession
NotFoundException
- no antimatroid found by the given
Id
NullArgumentException
- chainReceiver
or
antimatroidId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsChainNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsChainNotification()
and
supportsVisibleFederation()
are true
ChainAntimatroidSession getChainAntimatroidSession() throws OperationFailedException
OsidSession
to lookup chain/antimatroid
mappings. ChainAntimatroidSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsChainAntimatroid()
is false
optional
- This method must be implemented if
supportsChainAntimatroid()
is true.
ChainAntimatroidAssignmentSession getChainAntimatroidAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning chains
to antimatroids. ChainAntimatroidAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsChainAntimatroidAssignment()
is false
optional
- This method must be implemented if
supportsChainAntimatroidAssignment()
is
true.
ChainSmartAntimatroidSession getChainSmartAntimatroidSession(Id antimatroidId) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart
antimatroids.antimatroidId
- the Id
of the Antimatroid
ChainSmartAntimatroidSession
NotFoundException
- no antimatroid found by the given
Id
NullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsChainSmartAntimatroid()
is false
optional
- This method must be implemented if
supportsChainSmartAntimatroid()
is true.
AntimatroidLookupSession getAntimatroidLookupSession() throws OperationFailedException
OsidSession
associated with the antimatroid
lookup service. AntimatroidLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAntimatroidLookup()
is false
optional
- This method must be implemented if
supportsAntimatroidLookup()
is true.
AntimatroidQuerySession getAntimatroidQuerySession() throws OperationFailedException
OsidSession
associated with the antimatroid
query service. AntimatroidQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAntimatroidQuery()
is false
optional
- This method must be implemented if
supportsAntimatroidQuery()
is true.
AntimatroidSearchSession getAntimatroidSearchSession() throws OperationFailedException
OsidSession
associated with the antimatroid
search service. AntimatroidSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAntimatroidSearch()
is false
optional
- This method must be implemented if
supportsAntimatroidSearch()
is true.
AntimatroidAdminSession getAntimatroidAdminSession() throws OperationFailedException
OsidSession
associated with the antimatroid
administrative service. AntimatroidAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAntimatroidAdmin()
is false
optional
- This method must be implemented if
supportsAntimatroidAdmin()
is true.
AntimatroidNotificationSession getAntimatroidNotificationSession(AntimatroidReceiver antimatroidReceiver) throws OperationFailedException
OsidSession
associated with the antimatroid
notification service.antimatroidReceiver
- the notification callback AntimatroidNotificationSession
NullArgumentException
- antimatroidReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAntimatroidNotification()
is false
optional
- This method must be implemented if
supportsAntimatroidNotification()
is true.
AntimatroidHierarchySession getAntimatroidHierarchySession() throws OperationFailedException
OsidSession
associated with the antimatroid
hierarchy service. AntimatroidHierarchySession
for antimatroidsOperationFailedException
- unable to complete requestUnimplementedException
-
supportsAntimatroidHierarchy()
is false
optional
- This method must be implemented if
supportsAntimatroidHierarchy()
is true.
AntimatroidHierarchyDesignSession getAntimatroidHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the antimatroid
hierarchy design service. HierarchyDesignSession
for antimatroidsOperationFailedException
- unable to complete requestUnimplementedException
-
supportsAntimatroidHierarchyDesign()
is false
optional
- This method must be implemented if
supportsAntimatroidHierarchyDesign()
is
true.