OSID - osid.dictionary.EntrySmartDictionarySession Service Interface Definition

Interface	osid.dictionary.EntrySmartDictionarySession
Implements	`osid.OsidSession`
Used By	`osid.dictionary.DictionaryManager`
Used By	`osid.dictionary.DictionaryProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `EntryQuery` can be retrieved from this session and mapped to this `Dictionary` to create a virtual collection of `Entries` . The entries may be sequenced using the `EntrySearchOrder` from this session. This `Dictionary` has a default query that matches any entry and a default search order that specifies no sequencing. The queries may be examined using an `EntryQueryInspector` . The query may be modified by converting the inspector back to an `EntryQuery` .
Method	getDictionaryId
Description	Gets the `Dictionary` `Id` associated with this session.
Return	`osid.id.Id`		the `Dictionary Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDictionary
Description	Gets the `Dictionary` associated with this session.
Return	`osid.dictionary.Dictionary`		the `Dictionary` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartDictionaries
Description	Tests if this user can manage smart dictionarys. 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 application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart dictionary management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEntryQuery
Description	Gets an entry query.
Return	`osid.dictionary.EntryQuery`		the entry query
Compliance	`mandatory`		This method must be implemented.
Method	getEntrySearchOrder
Description	Gets an entry search order.
Return	`osid.dictionary.EntrySearchOrder`		the entry search order
Compliance	`mandatory`		This method must be implemented.
Method	applyEntryQuery
Description	Applies an entry query to this dictionary.
Parameters	`osid.dictionary.EntryQuery`	`entryQuery`	the entry query
Errors	NULL_ARGUMENT		`entryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`entryQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectEntryQuery
Description	Gets an entry query inspector for this dictionary.
Return	`osid.dictionary.EntryQueryInspector`		the entry query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyEntrySequencing
Description	Applies an entry search order to this dictionary.
Parameters	`osid.dictionary.EntrySearchOrder`	`entrySearchOrder`	the entry search order
Errors	NULL_ARGUMENT		`entrySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`entrySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getEntryQueryFromInspector
Description	Gets an entry query from an inspector.
Parameters	`osid.dictionary.EntryQueryInspector`	`entryQueryInspector`	an entry query inspector
Return	`osid.dictionary.EntryQuery`		the entry query
Errors	NULL_ARGUMENT		`entryQueryInspector` is `null`
Errors	UNSUPPORTED		`entryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.