OSID - osid.calendaring.rules.CommitmentEnablerLookupSession Service Interface Definition

Interface	osid.calendaring.rules.CommitmentEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `CommitmentEnablers.` 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 calendar view: All commitment enabler methods in this session operate, retrieve and pertain to commitment enablers defined explicitly in the current calendar. Using an isolated view is useful for managing `CommitmentEnablers` with the `CommitmentEnablerAdminSession.` federated calendar view: All commitment enabler methods in this session operate, retrieve and pertain to all commitment enablers defined in this calendar and any other commitment enablers implicitly available in this calendar through calendar inheritence. active commitment enabler view: All commitment enabler lookup methods return active commitment enablers. any status commitment enabler view: Commitment enablers 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 `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking the methods in this session.
Method	getCalendarId
Description	Gets the `Calendar` `Id` associated with this session.
Return	`osid.id.Id`		the `Calendar Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCalendar
Description	Gets the `Calendar` associated with this session.
Return	`osid.calendaring.Calendar`		the calendar
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupCommitmentEnablers
Description	Tests if this user can perform `CommitmentEnablers` 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	useComparativeCommitmentEnablerView
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	usePlenaryCommitmentEnablerView
Description	A complete view of the `CommitmentEnabler` 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	useFederatedCalendarView
Description	Federates the view for methods in this session. A federated view will include commitment enablers in calendars which are children of this calendar in the calendar hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCalendarView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveCommitmentEnablerView
Description	Only active commitment enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusCommitmentEnablerView
Description	All active and inactive commitment enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getCommitmentEnabler
Description	Gets the `CommitmentEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `CommitmentEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `CommitmentEnabler` and retained for compatibility. In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned.
Parameters	`osid.id.Id`	`commitmentEnablerId`	`Id` of the `CommitmentEnabler`
Return	`osid.calendaring.rules.CommitmentEnabler`		the commitment enabler
Errors	NOT_FOUND		`commitmentEnablerId` not found
	NULL_ARGUMENT		`commitmentEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCommitmentEnablersByIds
Description	Gets a `CommitmentEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the commitment enablers 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 `CommitmentEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned.
Parameters	`osid.id.IdList`	`commitmentEnablerIds`	the list of `Ids` to retrieve
Return	`osid.calendaring.rules.CommitmentEnablerList`		the returned `CommitmentEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`commitmentEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablersByGenusType
Description	Gets a `CommitmentEnablerList` corresponding to the given commitment enabler genus `Type` which does not include commitment enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known commitment enablers or an error results. Otherwise, the returned list may contain only those commitment enablers that are accessible through this session. In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned.
Parameters	`osid.type.Type`	`commitmentEnablerGenusType`	a commitment enabler genus type
Return	`osid.calendaring.rules.CommitmentEnablerList`		the returned `CommitmentEnabler` list
Errors	NULL_ARGUMENT		`commitmentEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablersByParentGenusType
Description	Gets a `CommitmentEnablerList` corresponding to the given commitment enabler genus `Type` and include any additional commitment enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known commitment enablers or an error results. Otherwise, the returned list may contain only those commitment enablers that are accessible through this session. In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned.
Parameters	`osid.type.Type`	`commitmentEnablerGenusType`	a commitment enabler genus type
Return	`osid.calendaring.rules.CommitmentEnablerList`		the returned `CommitmentEnabler` list
Errors	NULL_ARGUMENT		`commitmentEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablersByRecordType
Description	Gets a `CommitmentEnablerList` containing the given commitment enabler record `Type.` In plenary mode, the returned list contains all known commitment enablers or an error results. Otherwise, the returned list may contain only those commitment enablers that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.type.Type`	`commitmentEnablerRecordType`	a commitment enabler record type
Return	`osid.calendaring.rules.CommitmentEnablerList`		the returned `CommitmentEnabler` list
Errors	NULL_ARGUMENT		`commitmentEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablersOnDate
Description	Gets a `CommitmentEnablerList` effective during the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known commitment enablers or an error results. Otherwise, the returned list may contain only those commitment enablers that are accessible through this session. In active mode, commitment enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive commitment enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.calendaring.rules.CommitmentEnablerList`		the returned `CommitmentEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablersOnDateWithAgent
Description	Gets a `CommitmentEnablerList` effective during the entire given date range inclusive but not confined to the date range evaluated against the given agent. In plenary mode, the returned list contains all known commitment enablers or an error results. Otherwise, the returned list may contain only those commitment enablers that are accessible through this session. In active mode, commitment enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive commitment enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent Id
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.calendaring.rules.CommitmentEnablerList`		the returned `CommitmentEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agent, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablers
Description	Gets all `CommitmentEnablers.` In plenary mode, the returned list contains all known commitment enablers or an error results. Otherwise, the returned list may contain only those commitment enablers that are accessible through this session. In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned.
Return	`osid.calendaring.rules.CommitmentEnablerList`		the returned `CommitmentEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.