Interface | osid.sequencing.SequencingManager | ||
---|---|---|---|
Implements | osid.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:
| ||
Method | getElementLookupSession | ||
Description |
Gets the | ||
Return | osid.sequencing.ElementLookupSession | an ElementLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsElementLookup() is false | ||
Compliance | optional | This method must be implemented if supportsElementLookup()
is true. | |
Method | getElementLookupSessionForAntimatroid | ||
Description |
Gets the | ||
Parameters | osid.id.Id | antimatroidId | the Id of the antimatroid |
Return | osid.sequencing.ElementLookupSession | an ElementLookupSession | |
Errors | NOT_FOUND | no Antimatroid found by the given Id | |
NULL_ARGUMENT | antimatroidId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsElementLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsElementLookup()
and supportsVisibleFederation() are true | |
Method | getElementAdminSession | ||
Description |
Gets the | ||
Return | osid.sequencing.ElementAdminSession | an ElementAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsElementAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsElementAdmin() is
true. | |
Method | getElementAdminSessionForAntimatroid | ||
Description |
Gets the | ||
Parameters | osid.id.Id | antimatroidId | the Id of the antimatroid |
Return | osid.sequencing.ElementAdminSession | an ElementAdminSession | |
Errors | NOT_FOUND | no Antimatroid found by the given Id | |
NULL_ARGUMENT | antimatroidId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsElementAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsElementAdmin()
and supportsVisibleFederation() are true | |
Method | getSequencingSession | ||
Description |
Gets the | ||
Return | osid.sequencing.SequencingSession | a SequencingSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSequencingn() is false | ||
Compliance | optional | This method must be implemented if supportsSequencing() is
true. | |
Method | getSequencingSessionForAntimatroid | ||
Description |
Gets the | ||
Parameters | osid.id.Id | antimatroidId | the Id of the antimatroid |
Return | osid.sequencing.SequencingSession | a SequencingSession | |
Errors | NOT_FOUND | no Antimatroid found by the given Id | |
NULL_ARGUMENT | antimatroidId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSequencing() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsSequencing() and
supportsVisibleFederation() are true | |
Method | getChainLookupSession | ||
Description |
Gets the | ||
Return | osid.sequencing.ChainLookupSession | a ChainLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsChainLookup() is false | ||
Compliance | optional | This method must be implemented if supportsChainLookup() is
true. | |
Method | getChainLookupSessionForAntimatroid | ||
Description |
Gets the | ||
Parameters | osid.id.Id | antimatroidId | the Id of the antimatroid |
Return | osid.sequencing.ChainLookupSession | a ChainLookupSession | |
Errors | NOT_FOUND | no Antimatroid found by the given Id | |
NULL_ARGUMENT | antimatroidId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsChainLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsChainLookup() and
supportsVisibleFederation() are true | |
Method | getChainQuerySession | ||
Description |
Gets the | ||
Return | osid.sequencing.ChainQuerySession | a ChainQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsChainQuery() is false | ||
Compliance | optional | This method must be implemented if supportsChainQuery() is
true. | |
Method | getChainQuerySessionForAntimatroid | ||
Description |
Gets the | ||
Parameters | osid.id.Id | antimatroidId | the Id of the Antimatroid |
Return | osid.sequencing.ChainQuerySession | a ChainQuerySession | |
Errors | NOT_FOUND | no antimatroid found by the given Id | |
NULL_ARGUMENT | antimatroidId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsChainQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsChainQuery() and
supportsVisibleFederation() are true | |
Method | getChainSearchSession | ||
Description |
Gets the | ||
Return | osid.sequencing.ChainSearchSession | a ChainSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsChainSearch() is false | ||
Compliance | optional | This method must be implemented if supportsChainSearch() is
true. | |
Method | getChainSearchSessionForAntimatroid | ||
Description |
Gets the | ||
Parameters | osid.id.Id | antimatroidId | the Id of the Antimatroid |
Return | osid.sequencing.ChainSearchSession | a ChainSearchSession | |
Errors | NOT_FOUND | no antimatroid found by the given Id | |
NULL_ARGUMENT | antimatroidId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsChainSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsChainSearch() and
supportsVisibleFederation() are true | |
Method | getChainAdminSession | ||
Description |
Gets the | ||
Return | osid.sequencing.ChainAdminSession | a ChainAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsChainAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsChainAdmin() is
true. | |
Method | getChainAdminSessionForInput | ||
Description |
Gets the | ||
Parameters | osid.id.Id | antimatroidId | the Id of the Dostributor |
Return | osid.sequencing.ChainAdminSession | a ChainAdminSession | |
Errors | NOT_FOUND | no antimatroid found by the given Id | |
NULL_ARGUMENT | antimatroidId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsChainAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsChainAdmin() and
supportsVisibleFederation() are true | |
Method | getChainNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.sequencing.ChainReceiver | chainReceiver | the notification callback |
Return | osid.sequencing.ChainNotificationSession | a ChainNotificationSession | |
Errors | NULL_ARGUMENT | chainReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsChainNotification() is false | ||
Compliance | optional | This method must be implemented if supportsChainNotification()
is true. | |
Method | getChainNotificationSessionForAntimatroid | ||
Description |
Gets the | ||
Parameters | osid.sequencing.ChainReceiver | chainReceiver | the notification callback |
osid.id.Id | antimatroidId | the Id of the Antimatroid | |
Return | osid.sequencing.ChainNotificationSession | a ChainNotificationSession | |
Errors | NOT_FOUND | no antimatroid found by the given Id | |
NULL_ARGUMENT | chainReceiver or antimatroidId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsChainNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsChainNotification()
and supportsVisibleFederation() are true | |
Method | getChainAntimatroidSession | ||
Description |
Gets the | ||
Return | osid.sequencing.ChainAntimatroidSession | a ChainAntimatroidSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsChainAntimatroid() is false | ||
Compliance | optional | This method must be implemented if supportsChainAntimatroid()
is true. | |
Method | getChainAntimatroidAssignmentSession | ||
Description |
Gets the | ||
Return | osid.sequencing.ChainAntimatroidAssignmentSession | a ChainAntimatroidAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsChainAntimatroidAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsChainAntimatroidAssignment() is true. | |
Method | getChainSmartAntimatroidSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | antimatroidId | the Id of the Antimatroid |
Return | osid.sequencing.ChainSmartAntimatroidSession | a ChainSmartAntimatroidSession | |
Errors | NOT_FOUND | no antimatroid found by the given Id | |
NULL_ARGUMENT | antimatroidId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsChainSmartAntimatroid() is false | ||
Compliance | optional | This method must be implemented if supportsChainSmartAntimatroid()
is true. | |
Method | getAntimatroidLookupSession | ||
Description |
Gets the | ||
Return | osid.sequencing.AntimatroidLookupSession | a AntimatroidLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAntimatroidLookup() is false | ||
Compliance | optional | This method must be implemented if supportsAntimatroidLookup()
is true. | |
Method | getAntimatroidQuerySession | ||
Description |
Gets the | ||
Return | osid.sequencing.AntimatroidQuerySession | an AntimatroidQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAntimatroidQuery() is false | ||
Compliance | optional | This method must be implemented if supportsAntimatroidQuery()
is true. | |
Method | getAntimatroidSearchSession | ||
Description |
Gets the | ||
Return | osid.sequencing.AntimatroidSearchSession | an AntimatroidSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAntimatroidSearch() is false | ||
Compliance | optional | This method must be implemented if supportsAntimatroidSearch()
is true. | |
Method | getAntimatroidAdminSession | ||
Description |
Gets the | ||
Return | osid.sequencing.AntimatroidAdminSession | an AntimatroidAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAntimatroidAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsAntimatroidAdmin()
is true. | |
Method | getAntimatroidNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.sequencing.AntimatroidReceiver | antimatroidReceiver | the notification callback |
Return | osid.sequencing.AntimatroidNotificationSession | an AntimatroidNotificationSession | |
Errors | NULL_ARGUMENT | antimatroidReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAntimatroidNotification() is false | ||
Compliance | optional | This method must be implemented if supportsAntimatroidNotification()
is true. | |
Method | getAntimatroidHierarchySession | ||
Description |
Gets the | ||
Return | osid.sequencing.AntimatroidHierarchySession | an AntimatroidHierarchySession for antimatroids | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAntimatroidHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsAntimatroidHierarchy()
is true. | |
Method | getAntimatroidHierarchyDesignSession | ||
Description |
Gets the | ||
Return | osid.sequencing.AntimatroidHierarchyDesignSession | an HierarchyDesignSession for antimatroids | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAntimatroidHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if
supportsAntimatroidHierarchyDesign() is true. |