OSID - osid.sequencing.SequencingManager Service Interface Definition

Interface	osid.sequencing.SequencingManager
Implements	`osid.OsidManager`
Implements	`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
Method	getElementLookupSession
Description	Gets the `OsidSession` associated with the element lookup service.
Return	`osid.sequencing.ElementLookupSession`		an `ElementLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsElementLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsElementLookup()` is `true.`
Method	getElementLookupSessionForAntimatroid
Description	Gets the `OsidSession` associated with the element lookup service for the given antimatroid.
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 `OsidSession` associated with the element admin service.
Return	`osid.sequencing.ElementAdminSession`		an `ElementAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsElementAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsElementAdmin()` is `true.`
Method	getElementAdminSessionForAntimatroid
Description	Gets the `OsidSession` associated with the element admin service for the given antimatroid.
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 `OsidSession` associated with the element sequencing service.
Return	`osid.sequencing.SequencingSession`		a `SequencingSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSequencingn()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSequencing()` is `true.`
Method	getSequencingSessionForAntimatroid
Description	Gets the `OsidSession` associated with the element sequencing service for the given antimatroid.
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 `OsidSession` associated with the chain lookup service.
Return	`osid.sequencing.ChainLookupSession`		a `ChainLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChainLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChainLookup()` is `true.`
Method	getChainLookupSessionForAntimatroid
Description	Gets the `OsidSession` associated with the chain lookup service for the given antimatroid.
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 `OsidSession` associated with the chain query service.
Return	`osid.sequencing.ChainQuerySession`		a `ChainQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChainQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChainQuery()` is `true.`
Method	getChainQuerySessionForAntimatroid
Description	Gets the `OsidSession` associated with the chain query service for the given antimatroid.
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 `OsidSession` associated with the chain search service.
Return	`osid.sequencing.ChainSearchSession`		a `ChainSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChainSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChainSearch()` is `true.`
Method	getChainSearchSessionForAntimatroid
Description	Gets the `OsidSession` associated with the chain search service for the given antimatroid.
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 `OsidSession` associated with the chain administration service.
Return	`osid.sequencing.ChainAdminSession`		a `ChainAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChainAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChainAdmin()` is `true.`
Method	getChainAdminSessionForInput
Description	Gets the `OsidSession` associated with the chain administration service for the given antimatroid.
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 `OsidSession` associated with the chain notification service.
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 `OsidSession` associated with the chain notification service for the given antimatroid.
Parameters	`osid.sequencing.ChainReceiver`	`chainReceiver`	the notification callback
Parameters	`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 `OsidSession` to lookup chain/antimatroid mappings.
Return	`osid.sequencing.ChainAntimatroidSession`		a `ChainAntimatroidSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChainAntimatroid()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChainAntimatroid()` is `true.`
Method	getChainAntimatroidAssignmentSession
Description	Gets the `OsidSession` associated with assigning chains to antimatroids.
Return	`osid.sequencing.ChainAntimatroidAssignmentSession`		a `ChainAntimatroidAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChainAntimatroidAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChainAntimatroidAssignment()` is `true.`
Method	getChainSmartAntimatroidSession
Description	Gets the `OsidSession` to manage locatin smart antimatroids.
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 `OsidSession` associated with the antimatroid lookup service.
Return	`osid.sequencing.AntimatroidLookupSession`		a `AntimatroidLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAntimatroidLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAntimatroidLookup()` is `true.`
Method	getAntimatroidQuerySession
Description	Gets the `OsidSession` associated with the antimatroid query service.
Return	`osid.sequencing.AntimatroidQuerySession`		an `AntimatroidQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAntimatroidQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAntimatroidQuery()` is `true.`
Method	getAntimatroidSearchSession
Description	Gets the `OsidSession` associated with the antimatroid search service.
Return	`osid.sequencing.AntimatroidSearchSession`		an `AntimatroidSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAntimatroidSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAntimatroidSearch()` is `true.`
Method	getAntimatroidAdminSession
Description	Gets the `OsidSession` associated with the antimatroid administrative service.
Return	`osid.sequencing.AntimatroidAdminSession`		an `AntimatroidAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAntimatroidAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAntimatroidAdmin()` is `true.`
Method	getAntimatroidNotificationSession
Description	Gets the `OsidSession` associated with the antimatroid notification service.
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 `OsidSession` associated with the antimatroid hierarchy service.
Return	`osid.sequencing.AntimatroidHierarchySession`		an `AntimatroidHierarchySession` for antimatroids
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAntimatroidHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAntimatroidHierarchy()` is `true.`
Method	getAntimatroidHierarchyDesignSession
Description	Gets the `OsidSession` associated with the antimatroid hierarchy design service.
Return	`osid.sequencing.AntimatroidHierarchyDesignSession`		an `HierarchyDesignSession` for antimatroids
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAntimatroidHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAntimatroidHierarchyDesign()` is `true.`