OSID - osid.lexicon.IdiomSmartPressSession Service Interface Definition

Interface	osid.lexicon.IdiomSmartPressSession
Implements	`osid.OsidSession`
Used By	`osid.lexicon.LexiconManager`
Used By	`osid.lexicon.LexiconProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `IdiomQuery` can be retrieved from this session and pressped to this `Press` to create a virtual collection of `Idioms` . The idioms may be sequenced using the `IdiomSearchOrder` from this session. This `Press` has a default query that matches any idiom and a default search order that specifies no sequencing. The queries may be examined using an `IdiomQueryInspector` . The query may be modified by converting the inspector back to an `IdiomQuery` .
Method	getPressId
Description	Gets the `Press` `Id` associated with this session.
Return	`osid.id.Id`		the `Press Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPress
Description	Gets the `Press` associated with this session.
Return	`osid.lexicon.Press`		the press
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartPresses
Description	Tests if this user can manage smart presses. 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 `PERMISSION_DENIED` . This is intended as a hint to an press that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart press management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIdiomQuery
Description	Gets an idiom query.
Return	`osid.lexicon.IdiomQuery`		the idiom query
Compliance	`mandatory`		This method must be implemented.
Method	getIdiomSearchOrder
Description	Gets an idiom search order.
Return	`osid.lexicon.IdiomSearchOrder`		the idiom search order
Compliance	`mandatory`		This method must be implemented.
Method	applyIdiomQuery
Description	Applies an idiom query to this press.
Parameters	`osid.lexicon.IdiomQuery`	`idiomQuery`	the idiom query
Errors	NULL_ARGUMENT		`idiomQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`idiomQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectIdiomQuery
Description	Gets an idiom query inspector for this press.
Return	`osid.lexicon.IdiomQueryInspector`		the idiom query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyIdiomSequencing
Description	Applies an idiom search order to this press.
Parameters	`osid.lexicon.IdiomSearchOrder`	`idiomSearchOrder`	the idiom search order
Errors	NULL_ARGUMENT		`idiomSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`idiomSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIdiomQueryFromInspector
Description	Gets an idiom query from an inspector.
Parameters	`osid.lexicon.IdiomQueryInspector`	`idiomQueryInspector`	an idiom query inspector
Return	`osid.lexicon.IdiomQuery`		the idiom query
Errors	NULL_ARGUMENT		`idiomQueryInspector` is `null`
Errors	UNSUPPORTED		`idiomQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.