OSID - osid.control.TriggerLookupSession Service Interface Definition

Interface	osid.control.TriggerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Trigger` 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 system view: All trigger methods in this session operate, retrieve and pertain to triggers defined explicitly in the current system. Using an isolated view is useful for managing `Triggers` with the `TriggerAdminSession.` federated system view: All trigger methods in this session operate, retrieve and pertain to all triggers defined in this system and any other triggers implicitly available in this system through system inheritence. active trigger view: active triggers are returned from methods in this session any status trigger view: active and inactive triggers are returned from methods in this session 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 `useFederatedSystemView()` and `useIsolatedSystemView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getSystemId
Description	Gets the `System` `Id` associated with this session.
Return	`osid.id.Id`		the `System Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getSystem
Description	Gets the `System` associated with this session.
Return	`osid.control.System`		the system
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupTriggers
Description	Tests if this user can perform `Trigger` 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	useComparativeTriggerView
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	usePlenaryTriggerView
Description	A complete view of the `Trigger` 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	useFederatedSystemView
Description	Federates the view for methods in this session. A federated view will include triggers in systems which are children of this system in the system hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedSystemView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this system only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveTriggerView
Description	Only active triggers are returned from methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusTriggerView
Description	Borth active and inactive triggers are returned from methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getTrigger
Description	Gets the `Trigger` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Trigger` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Trigger` and retained for compatibility. In active mode, triggers are returned that are currently active. In any status mode, active and inactive triggers are returned.
Parameters	`osid.id.Id`	`triggerId`	`Id` of the `Trigger`
Return	`osid.control.Trigger`		the trigger
Errors	NOT_FOUND		`triggerId` not found
	NULL_ARGUMENT		`triggerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getTriggersByIds
Description	Gets a `TriggerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the triggers 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 `Triggers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, triggers are returned that are currently active. In any status mode, active and inactive triggers are returned.
Parameters	`osid.id.IdList`	`triggerIds`	the list of `Ids` to retrieve
Return	`osid.control.TriggerList`		the returned `Trigger` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`triggerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTriggersByGenusType
Description	Gets a `TriggerList` corresponding to the given trigger genus `Type` which does not include triggers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known triggers or an error results. Otherwise, the returned list may contain only those triggers that are accessible through this session. In active mode, triggers are returned that are currently active. In any status mode, active and inactive triggers are returned.
Parameters	`osid.type.Type`	`triggerGenusType`	a trigger genus type
Return	`osid.control.TriggerList`		the returned `Trigger` list
Errors	NULL_ARGUMENT		`triggerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTriggersByParentGenusType
Description	Gets a `TriggerList` corresponding to the given trigger genus `Type` and include any additional triggers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known triggers or an error results. Otherwise, the returned list may contain only those triggers that are accessible through this session. In active mode, triggers are returned that are currently active. In any status mode, active and inactive triggers are returned.
Parameters	`osid.type.Type`	`triggerGenusType`	a trigger genus type
Return	`osid.control.TriggerList`		the returned `Trigger` list
Errors	NULL_ARGUMENT		`triggerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTriggersByRecordType
Description	Gets a `TriggerList` containing the given trigger record `Type.` In plenary mode, the returned list contains all known triggers or an error results. Otherwise, the returned list may contain only those triggers that are accessible through this session. In active mode, triggers are returned that are currently active. In any status mode, active and inactive triggers are returned.
Parameters	`osid.type.Type`	`triggerRecordType`	a trigger record type
Return	`osid.control.TriggerList`		the returned `Trigger` list
Errors	NULL_ARGUMENT		`triggerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTriggersForController
Description	Gets a list of triggers for the given controller. In plenary mode, the returned list contains all known triggers or an error results. Otherwise, the returned list may contain only those triggers that are accessible through this session. In active mode, triggers are returned that are currently active. In any status mode, active and inactive triggers are returned.
Parameters	`osid.id.Id`	`controllerId`	a controller `Id`
Return	`osid.control.TriggerList`		the returned `Trigger` list
Errors	NULL_ARGUMENT		`controllerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTriggers
Description	Gets all `Triggers.` In plenary mode, the returned list contains all known triggers or an error results. Otherwise, the returned list may contain only those triggers that are accessible through this session. In active mode, triggers are returned that are currently active. In any status mode, active and inactive triggers are returned.
Return	`osid.control.TriggerList`		a list of `Triggers`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.