OSID - osid.lexicon.TextSmartPressSession Service Interface Definition

Interface	osid.lexicon.TextSmartPressSession
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. A `TextQuery` can be retrieved from this session and pressped to this `Press` to create a virtual collection of `Texts` . The texts may be sequenced using the `TextSearchOrder` from this session. This `Press` has a default query that matches any text and a default search order that specifies no sequencing. The queries may be examined using a `TextQueryInspector` . The query may be modified by converting the inspector back to a `TextQuery` .
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	getTextQuery
Description	Gets a text query.
Return	`osid.lexicon.TextQuery`		the text query
Compliance	`mandatory`		This method must be implemented.
Method	getTextSearchOrder
Description	Gets a text search order.
Return	`osid.lexicon.TextSearchOrder`		the text search order
Compliance	`mandatory`		This method must be implemented.
Method	applyTextQuery
Description	Applies a text query to this press.
Parameters	`osid.lexicon.TextQuery`	`textQuery`	the text query
Errors	NULL_ARGUMENT		`textQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`textQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectTextQuery
Description	Gets a text query inspector for this press.
Return	`osid.lexicon.TextQueryInspector`		the text query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyTextSequencing
Description	Applies a text search order to this press.
Parameters	`osid.lexicon.TextSearchOrder`	`textSearchOrder`	the text search order
Errors	NULL_ARGUMENT		`textSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`textSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getTextQueryFromInspector
Description	Gets a text query from an inspector.
Parameters	`osid.lexicon.TextQueryInspector`	`textQueryInspector`	a text query inspector
Return	`osid.lexicon.TextQuery`		the text query
Errors	NULL_ARGUMENT		`textQueryInspector` is `null`
Errors	UNSUPPORTED		`textQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.