OSID - osid.rules.check.AgendaLookupSession Service Interface Definition

Interface	osid.rules.check.AgendaLookupSession
Implements	`osid.OsidSession`
Used By	`osid.rules.check.RulesCheckManager`
Used By	`osid.rules.check.RulesCheckProxyManager`
Description	This session provides methods for retrieving `Agenda` objects. 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 engine view: All agenda methods in this session operate, retrieve and pertain to agendas defined explicitly in the current engine. Using an isolated view is useful for managing `Agendas` with the `AgendaAdminSession`. federated engine view: All agenda methods in this session operate, retrieve and pertain to all agendas defined in this engine and any other agendas implicitly available in this engine through engine inheritence. active agenda view: All agenda lookup methods return active agendas. any status agenda view: Agendas of any active or inactive status are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedEngineView()` and `useIsolatedEngineView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getEngineId
Description	Gets the `Engine` `Id` associated with this session.
Return	`osid.id.Id`		the `Engine Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getEngine
Description	Gets the `Engine` associated with this session.
Return	`osid.rules.Engine`		the engine
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupAgendas
Description	Tests if this user can perform `Agenda` 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 application 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	useComparativeAgendaView
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	usePlenaryAgendaView
Description	A complete view of the `Agenda` 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	useFederatedEngineView
Description	Federates the view for methods in this session. A federated view will include agendas in engines which are children of this engine in the engine hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedEngineView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this engine only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveAgendaView
Description	Only active agendas are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusAgendaView
Description	All active and inactive agendas of are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getAgenda
Description	Gets the `Agenda` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Agenda` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Agenda` and retained for compatibility. In active mode, agendas are returned that are currently active. In any status mode, active and inactive agendas are returned.
Parameters	`osid.id.Id`	`agendaId`	`Id` of the `Agenda`
Return	`osid.rules.check.Agenda`		the agenda
Errors	NOT_FOUND		`agendaId` not found
	NULL_ARGUMENT		`agendaId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getAgendasByIds
Description	Gets an `AgendaList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the agendas 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 `Agendas` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, agendas are returned that are currently active. In any status mode, active and inactive agendas are returned.
Parameters	`osid.id.IdList`	`agendaIds`	the list of `Ids` to retrieve
Return	`osid.rules.check.AgendaList`		the returned `Agenda` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`agendaIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAgendasByGenusType
Description	Gets an `AgendaList` corresponding to the given agenda genus `Type` which does not include agendas of genus types derived from the specified `Type`. In plenary mode, the returned list contains all known agendas or an error results. Otherwise, the returned list may contain only those agendas that are accessible through this session. In active mode, agendas are returned that are currently active. In any status mode, active and inactive agendas are returned.
Parameters	`osid.type.Type`	`agendaGenusType`	an agenda genus type
Return	`osid.rules.check.AgendaList`		the returned `Agenda` list
Errors	NULL_ARGUMENT		`agendaGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAgendasByParentGenusType
Description	Gets an `AgendaList` corresponding to the given agenda genus `Type` and include any additional agendas with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known agendas or an error results. Otherwise, the returned list may contain only those agendas that are accessible through this session. In active mode, agendas are returned that are currently active. In any status mode, active and inactive agendas are returned.
Parameters	`osid.type.Type`	`agendaGenusType`	an agenda genus type
Return	`osid.rules.check.AgendaList`		the returned `Agenda` list
Errors	NULL_ARGUMENT		`agendaGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAgendasByRecordType
Description	Gets an `AgendaList` containing the given agenda record `Type`. In plenary mode, the returned list contains all known agendas or an error results. Otherwise, the returned list may contain only those agendas that are accessible through this session. In active mode, agendas are returned that are currently active. In any status mode, active and inactive agendas are returned.
Parameters	`osid.type.Type`	`agendaRecordType`	an agenda record type
Return	`osid.rules.check.AgendaList`		the returned `Agenda` list
Errors	NULL_ARGUMENT		`agendaRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAgendas
Description	Gets all `Agendas`. In plenary mode, the returned list contains all known agendas or an error results. Otherwise, the returned list may contain only those agendas that are accessible through this session. In active mode, agendas are returned that are currently active. In any status mode, active and inactive agendas are returned.
Return	`osid.rules.check.AgendaList`		a list of `Agendas`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.