OSID - osid.lexicon.TextLookupSession Service Interface Definition

Interface	osid.lexicon.TextLookupSession
Implements	`osid.OsidSession`
Used By	`osid.lexicon.LexiconManager`
Used By	`osid.lexicon.LexiconProxyManager`
Description	This session provides methods for retrieving `Text` objects. The `Text` represents a fixed connection between two `Texts` . This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated press view: All text methods in this session operate, retrieve and pertain to texts defined explicitly in the current press. Using an isolated view is useful for managing `Texts` with the `TextAdminSession` . federated press view: All text methods in this session operate, retrieve and pertain to all texts defined in this press and any other texts implicitly available in this press through press inheritence. Generally, the comparative view should be used for most presses as it permits operation even if there is data that cannot be accessed. The methods `useFederatedPressView()` and `useIsolatedPressView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupTexts
Description	Tests if this user can perform `Text` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeTextView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryTextView
Description	A complete view of the `Text` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedPressView
Description	Federates the view for methods in this session. A federated view will include texts in presses which are children of this press in the press hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPressView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this press only.
Compliance	`mandatory`		This method is must be implemented.
Method	getText
Description	Gets the `Text` specified by its `Id` . In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Text` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Text` and retained for compatibility.
Parameters	`osid.id.Id`	`textId`	`Id` of the `Text`
Return	`osid.lexicon.Text`		the text
Errors	NOT_FOUND		`textId` not found
	NULL_ARGUMENT		`textId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getTextsByIds
Description	Gets a `TextList` corresponding to the given `IdList` . In plenary mode, the returned list contains all of the texts specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Texts` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`textIds`	the list of `Ids` to retrieve
Return	`osid.lexicon.TextList`		the returned `Text` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`textIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTextsByGenusType
Description	Gets a `TextList` corresponding to the given text genus `Type` which does not include texts of genus types derived from the specified `Type` . In plenary mode, the returned list contains all known texts or an error results. Otherwise, the returned list may contain only those texts that are accessible through this session. In effective mode, texts are returned that are currently effective. In any effective mode, effective texts and those currently expired are returned.
Parameters	`osid.type.Type`	`textGenusType`	a text genus type
Return	`osid.lexicon.TextList`		the returned `Text` list
Errors	NULL_ARGUMENT		`textGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTextsByParentGenusType
Description	Gets a `TextList` corresponding to the given text genus `Type` and include any additional texts with genus types derived from the specified `Type` . In plenary mode, the returned list contains all known texts or an error results. Otherwise, the returned list may contain only those texts that are accessible through this session.
Parameters	`osid.type.Type`	`textGenusType`	a text genus type
Return	`osid.lexicon.TextList`		the returned `Text` list
Errors	NULL_ARGUMENT		`textGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTextsByRecordType
Description	Gets a `TextList` containing the given text record `Type` . In plenary mode, the returned list contains all known texts or an error results. Otherwise, the returned list may contain only those texts that are accessible through this session.
Parameters	`osid.type.Type`	`textRecordType`	a text record type
Return	`osid.lexicon.TextList`		the returned `Text` list
Errors	NULL_ARGUMENT		`textRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTexts
Description	Gets all `Texts` . In plenary mode, the returned list contains all known texts or an error results. Otherwise, the returned list may contain only those texts that are accessible through this session. In effective mode, texts are returned that are currently effective. In any effective mode, effective texts and those currently expired are returned.
Return	`osid.lexicon.TextList`		a list of `Texts`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.