Interface | osid.sequencing.ChainSmartAntimatroidSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getAntimatroidId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Antimatroid Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAntimatroid | ||
Description |
Gets the | ||
Return | osid.sequencing.Antimatroid | the antimatroid | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartAntimatroids | ||
Description |
Tests if this user can manage smart antimatroids. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known methods in this session will result in a | ||
Return | boolean | false if smart antimatroid management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getChainQuery | ||
Description |
Gets a chain query. | ||
Return | osid.sequencing.ChainQuery | the chain query | |
Compliance | mandatory | This method must be implemented. | |
Method | getChainSearchOrder | ||
Description |
Gets a chain search order. | ||
Return | osid.sequencing.ChainSearchOrder | the chain search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyChainQuery | ||
Description |
Applies a chain query to this antimatroid. | ||
Parameters | osid.sequencing.ChainQuery | chainQuery | the chain query |
Errors | NULL_ARGUMENT | chainQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | chainQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectChainQuery | ||
Description |
Gets a chain query inspector for this antimatroid. | ||
Return | osid.sequencing.ChainQueryInspector | the chain query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyChainSequencing | ||
Description |
Applies a chain search order to this antimatroid. | ||
Parameters | osid.sequencing.ChainSearchOrder | chainSearchOrder | the chain search order |
Errors | NULL_ARGUMENT | chainSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | chainSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChainQueryFromInspector | ||
Description |
Gets a chain query from an inspector. | ||
Parameters | osid.sequencing.ChainQueryInspector | chainQueryInspector | a chain query inspector |
Return | osid.sequencing.ChainQuery | the chain query | |
Errors | NULL_ARGUMENT | chainQueryInspector is null | |
UNSUPPORTED | chainQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |