OSID Logo
OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.sequencing.SequencingManager
Implementsosid.OsidManager
osid.sequencing.SequencingProfile
Description

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
MethodgetElementLookupSession
Description

Gets the OsidSession associated with the element lookup service.

Returnosid.sequencing.ElementLookupSessionan ElementLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsElementLookup() is false
ComplianceoptionalThis method must be implemented if supportsElementLookup() is true.
MethodgetElementLookupSessionForAntimatroid
Description

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

Parametersosid.id.IdantimatroidIdthe Id of the antimatroid
Returnosid.sequencing.ElementLookupSessionan ElementLookupSession
ErrorsNOT_FOUNDno Antimatroid found by the given Id
NULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsElementLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsElementLookup() and supportsVisibleFederation() are true
MethodgetElementAdminSession
Description

Gets the OsidSession associated with the element admin service.

Returnosid.sequencing.ElementAdminSessionan ElementAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsElementAdmin() is false
ComplianceoptionalThis method must be implemented if supportsElementAdmin() is true.
MethodgetElementAdminSessionForAntimatroid
Description

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

Parametersosid.id.IdantimatroidIdthe Id of the antimatroid
Returnosid.sequencing.ElementAdminSessionan ElementAdminSession
ErrorsNOT_FOUNDno Antimatroid found by the given Id
NULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsElementAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsElementAdmin() and supportsVisibleFederation() are true
MethodgetSequencingSession
Description

Gets the OsidSession associated with the element sequencing service.

Returnosid.sequencing.SequencingSessiona SequencingSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSequencingn() is false
ComplianceoptionalThis method must be implemented if supportsSequencing() is true.
MethodgetSequencingSessionForAntimatroid
Description

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

Parametersosid.id.IdantimatroidIdthe Id of the antimatroid
Returnosid.sequencing.SequencingSessiona SequencingSession
ErrorsNOT_FOUNDno Antimatroid found by the given Id
NULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSequencing() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSequencing() and supportsVisibleFederation() are true
MethodgetChainLookupSession
Description

Gets the OsidSession associated with the chain lookup service.

Returnosid.sequencing.ChainLookupSessiona ChainLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChainLookup() is false
ComplianceoptionalThis method must be implemented if supportsChainLookup() is true.
MethodgetChainLookupSessionForAntimatroid
Description

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

Parametersosid.id.IdantimatroidIdthe Id of the antimatroid
Returnosid.sequencing.ChainLookupSessiona ChainLookupSession
ErrorsNOT_FOUNDno Antimatroid found by the given Id
NULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChainLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsChainLookup() and supportsVisibleFederation() are true
MethodgetChainQuerySession
Description

Gets the OsidSession associated with the chain query service.

Returnosid.sequencing.ChainQuerySessiona ChainQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChainQuery() is false
ComplianceoptionalThis method must be implemented if supportsChainQuery() is true.
MethodgetChainQuerySessionForAntimatroid
Description

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

Parametersosid.id.IdantimatroidIdthe Id of the Antimatroid
Returnosid.sequencing.ChainQuerySessiona ChainQuerySession
ErrorsNOT_FOUNDno antimatroid found by the given Id
NULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChainQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsChainQuery() and supportsVisibleFederation() are true
MethodgetChainSearchSession
Description

Gets the OsidSession associated with the chain search service.

Returnosid.sequencing.ChainSearchSessiona ChainSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChainSearch() is false
ComplianceoptionalThis method must be implemented if supportsChainSearch() is true.
MethodgetChainSearchSessionForAntimatroid
Description

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

Parametersosid.id.IdantimatroidIdthe Id of the Antimatroid
Returnosid.sequencing.ChainSearchSessiona ChainSearchSession
ErrorsNOT_FOUNDno antimatroid found by the given Id
NULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChainSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsChainSearch() and supportsVisibleFederation() are true
MethodgetChainAdminSession
Description

Gets the OsidSession associated with the chain administration service.

Returnosid.sequencing.ChainAdminSessiona ChainAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChainAdmin() is false
ComplianceoptionalThis method must be implemented if supportsChainAdmin() is true.
MethodgetChainAdminSessionForInput
Description

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

Parametersosid.id.IdantimatroidIdthe Id of the Dostributor
Returnosid.sequencing.ChainAdminSessiona ChainAdminSession
ErrorsNOT_FOUNDno antimatroid found by the given Id
NULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChainAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsChainAdmin() and supportsVisibleFederation() are true
MethodgetChainNotificationSession
Description

Gets the OsidSession associated with the chain notification service.

Parametersosid.sequencing.ChainReceiverchainReceiverthe notification callback
Returnosid.sequencing.ChainNotificationSessiona ChainNotificationSession
ErrorsNULL_ARGUMENT chainReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChainNotification() is false
ComplianceoptionalThis method must be implemented if supportsChainNotification() is true.
MethodgetChainNotificationSessionForAntimatroid
Description

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

Parametersosid.sequencing.ChainReceiverchainReceiverthe notification callback
osid.id.IdantimatroidIdthe Id of the Antimatroid
Returnosid.sequencing.ChainNotificationSessiona ChainNotificationSession
ErrorsNOT_FOUNDno antimatroid found by the given Id
NULL_ARGUMENT chainReceiver or antimatroidId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChainNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsChainNotification() and supportsVisibleFederation() are true
MethodgetChainAntimatroidSession
Description

Gets the OsidSession to lookup chain/antimatroid mappings.

Returnosid.sequencing.ChainAntimatroidSessiona ChainAntimatroidSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChainAntimatroid() is false
ComplianceoptionalThis method must be implemented if supportsChainAntimatroid() is true.
MethodgetChainAntimatroidAssignmentSession
Description

Gets the OsidSession associated with assigning chains to antimatroids.

Returnosid.sequencing.ChainAntimatroidAssignmentSessiona ChainAntimatroidAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChainAntimatroidAssignment() is false
ComplianceoptionalThis method must be implemented if supportsChainAntimatroidAssignment() is true.
MethodgetChainSmartAntimatroidSession
Description

Gets the OsidSession to manage locatin smart antimatroids.

Parametersosid.id.IdantimatroidIdthe Id of the Antimatroid
Returnosid.sequencing.ChainSmartAntimatroidSessiona ChainSmartAntimatroidSession
ErrorsNOT_FOUNDno antimatroid found by the given Id
NULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChainSmartAntimatroid() is false
ComplianceoptionalThis method must be implemented if supportsChainSmartAntimatroid() is true.
MethodgetAntimatroidLookupSession
Description

Gets the OsidSession associated with the antimatroid lookup service.

Returnosid.sequencing.AntimatroidLookupSessiona AntimatroidLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAntimatroidLookup() is false
ComplianceoptionalThis method must be implemented if supportsAntimatroidLookup() is true.
MethodgetAntimatroidQuerySession
Description

Gets the OsidSession associated with the antimatroid query service.

Returnosid.sequencing.AntimatroidQuerySessionan AntimatroidQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAntimatroidQuery() is false
ComplianceoptionalThis method must be implemented if supportsAntimatroidQuery() is true.
MethodgetAntimatroidSearchSession
Description

Gets the OsidSession associated with the antimatroid search service.

Returnosid.sequencing.AntimatroidSearchSessionan AntimatroidSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAntimatroidSearch() is false
ComplianceoptionalThis method must be implemented if supportsAntimatroidSearch() is true.
MethodgetAntimatroidAdminSession
Description

Gets the OsidSession associated with the antimatroid administrative service.

Returnosid.sequencing.AntimatroidAdminSessionan AntimatroidAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAntimatroidAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAntimatroidAdmin() is true.
MethodgetAntimatroidNotificationSession
Description

Gets the OsidSession associated with the antimatroid notification service.

Parametersosid.sequencing.AntimatroidReceiverantimatroidReceiverthe notification callback
Returnosid.sequencing.AntimatroidNotificationSessionan AntimatroidNotificationSession
ErrorsNULL_ARGUMENT antimatroidReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAntimatroidNotification() is false
ComplianceoptionalThis method must be implemented if supportsAntimatroidNotification() is true.
MethodgetAntimatroidHierarchySession
Description

Gets the OsidSession associated with the antimatroid hierarchy service.

Returnosid.sequencing.AntimatroidHierarchySessionan AntimatroidHierarchySession for antimatroids
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAntimatroidHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsAntimatroidHierarchy() is true.
MethodgetAntimatroidHierarchyDesignSession
Description

Gets the OsidSession associated with the antimatroid hierarchy design service.

Returnosid.sequencing.AntimatroidHierarchyDesignSessionan HierarchyDesignSession for antimatroids
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAntimatroidHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsAntimatroidHierarchyDesign() is true.