OSID - osid.profile.rules.ProfileEntryEnablerLookupSession Service Interface Definition

Interface	osid.profile.rules.ProfileEntryEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `ProfileEntryEnablers.` 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 profile view: All profile entry enabler methods in this session operate, retrieve and pertain to profile entry enablers defined explicitly in the current profile. Using an isolated view is useful for managing `ProfileEntryEnablers` with the `ProfileEntryEnablerAdminSession.` federated profile view: All profile entry enabler methods in this session operate, retrieve and pertain to all profile entry enablers defined in this profile and any other profile entry enablers implicitly available in this profile through profile inheritence. status profile entry enabler view: All profile entry enabler lookup methods return active profile entry. any status profile entry enabler view: Profile entry 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	getProfileId
Description	Gets the `Profile` `Id` associated with this session.
Return	`osid.id.Id`		the `Profile Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getProfile
Description	Gets the `Profile` associated with this session.
Return	`osid.profile.Profile`		the profile
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupProfileEntryEnablers
Description	Tests if this user can perform `ProfileEntryEnablers` 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	useComparativeProfileEntryEnablerView
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	usePlenaryProfileEntryEnablerView
Description	A complete view of the `ProfileEntryEnabler` 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	useFederatedProfileView
Description	Federates the view for methods in this session. A federated view will include profile entry enablers in profiles which are children of this profile in the profile hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedProfileView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this profile only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveProfileEntryEnablerView
Description	Only active profile entry enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusProfileEntryEnablerView
Description	All active and inactive profile entry enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getProfileEntryEnabler
Description	Gets the `ProfileEntryEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `ProfileEntryEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `ProfileEntryEnabler` and retained for compatibility. In active mode, profile entry enablers are returned that are currently active. In any status mode, active and inactive profile entry enablers are returned.
Parameters	`osid.id.Id`	`profileEntryEnablerId`	`Id` of the `ProfileEntryEnabler`
Return	`osid.profile.rules.ProfileEntryEnabler`		the profile entry enabler
Errors	NOT_FOUND		`profileEntryEnablerId` not found
	NULL_ARGUMENT		`profileEntryEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getProfileEntryEnablersByIds
Description	Gets a `ProfileEntryEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the profile entry 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 `ProfileEntryEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, profile entry enablers are returned that are currently active. In any status mode, active and inactive profile entry enablers are returned.
Parameters	`osid.id.IdList`	`profileEntryEnablerIds`	the list of `Ids` to retrieve
Return	`osid.profile.rules.ProfileEntryEnablerList`		the returned `ProfileEntryEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`profileEntryEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryEnablersByGenusType
Description	Gets a `ProfileEntryEnablerList` corresponding to the given profile entry enabler genus `Type` which does not include profile entry enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known profile entry enablers or an error results. Otherwise, the returned list may contain only those profile entry enablers that are accessible through this session. In active mode, profile entry enablers are returned that are currently active. In any status mode, active and inactive profile entry enablers are returned.
Parameters	`osid.type.Type`	`profileEntryEnablerGenusType`	a profile entry enabler genus type
Return	`osid.profile.rules.ProfileEntryEnablerList`		the returned `ProfileEntryEnabler` list
Errors	NULL_ARGUMENT		`profileEntryEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryEnablersByParentGenusType
Description	Gets a `ProfileEntryEnablerList` corresponding to the given profile entry enabler genus `Type` and include any additional profile entry enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known profile entry enablers or an error results. Otherwise, the returned list may contain only those profile entry enablers that are accessible through this session. In active mode, profile entry enablers are returned that are currently active. In any status mode, active and inactive profile entry enablers are returned.
Parameters	`osid.type.Type`	`profileEntryEnablerGenusType`	a profile entry enabler genus type
Return	`osid.profile.rules.ProfileEntryEnablerList`		the returned `ProfileEntryEnabler` list
Errors	NULL_ARGUMENT		`profileEntryEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryEnablersByRecordType
Description	Gets a `ProfileEntryEnablerList` containing the given profile entry enabler record `Type.` In plenary mode, the returned list contains all known profile entry enablers or an error results. Otherwise, the returned list may contain only those profile entry enablers that are accessible through this session. In active mode, profile entry enablers are returned that are currently active. In any status mode, active and inactive profile entry enablers are returned.
Parameters	`osid.type.Type`	`profileEntryEnablerRecordType`	a profile entry enabler record type
Return	`osid.profile.rules.ProfileEntryEnablerList`		the returned `ProfileEntryEnabler` list
Errors	NULL_ARGUMENT		`profileEntryEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryEnablersOnDate
Description	Gets a `ProfileEntryEnablerList` 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 profile entry enablers or an error results. Otherwise, the returned list may contain only those profile entry enablers that are accessible through this session. In active mode, profile entry enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive profile entry enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.profile.rules.ProfileEntryEnablerList`		the returned `ProfileEntryEnabler` 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	getProfileEntryEnablersOnDateWithAgent
Description	Gets a `ProfileEntryEnablerList` effective during the entire given date range inclusive but not confined to the date range aveluated against the given agent. In plenary mode, the returned list contains all known profile entry enablers or an error results. Otherwise, the returned list may contain only those profile entry enablers that are accessible through this session. In active mode, profile entry enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive profile entry 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.profile.rules.ProfileEntryEnablerList`		the returned `ProfileEntryEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryEnablers
Description	Gets all `ProfileEntryEnablers.` In plenary mode, the returned list contains all known profile entry enablers or an error results. Otherwise, the returned list may contain only those profile entry enablers that are accessible through this session. In active mode, profile entry enablers are returned that are currently active. In any status mode, active and inactive profile entry enablers are returned.
Return	`osid.profile.rules.ProfileEntryEnablerList`		the returned `ProfileEntryEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.