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

Interface	osid.profile.rules.ProfileEntryEnablerRuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.profile.rules.ProfileRulesManager`
Used By	`osid.profile.rules.ProfileRulesProxyManager`
Description	This session provides methods to retrieve `ProfileEntryEnabler` to `ProfileEntry` mappings. A `Profile` with multiple `ProfileEntryEnablers` means any positive rule evaluation across the enablers result in an enabled `ProfileEntry`. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated profile view: All methods in this session operate, retrieve and pertain profile entry enablers defined explicitly in the current profile federated profile view: All 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.
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	canLookupProfileEntryEnablerRules
Description	Tests if this user can perform lookups of profile entry enabler/profile entry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeProfileEntryEnablerRuleView
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	usePlenaryProfileEntryEnablerRuleView
Description	A complete view of the `ProfileEntryEnabler` and `ProfileEntry` 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	getProfileEntryEnablerIdsForProfileEntry
Description	Gets the `ProfileEntryEnabler Id` associated with a `ProfileEntry`.
Parameters	`osid.id.Id`	`profileEntryId`	`Id` of the `ProfileEntry`
Return	`osid.id.IdList`		the profile entry enabler `Ids`
Errors	NOT_FOUND		`profileEntryId` is not found
	NULL_ARGUMENT		`profileEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryEnablersForProfileEntry
Description	Gets the `ProfileEntryEnabler` associated with a `ProfileEntry`.
Parameters	`osid.id.Id`	`profileEntryId`	`Id` of the `ProfileEntry`
Return	`osid.profile.rules.ProfileEntryEnablerList`		the profile entry enablers
Errors	NOT_FOUND		`profileEntryId` is not found
	NULL_ARGUMENT		`profileEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryIdsForProfileEntryEnabler
Description	Gets the `ProfileEntry` `Ids` mapped to a `ProfileEntryEnabler`.
Parameters	`osid.id.Id`	`profileEntryEnablerId`	`Id` of a `ProfileEntryEnabler`
Return	`osid.id.IdList`		list of profile entry `Ids`
Errors	NOT_FOUND		`profileEntryEnablerId` is not found
	NULL_ARGUMENT		`profileEntryEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesForProfileEntryEnabler
Description	Gets the `ProfileEntries` mapped to a `ProfileEntryEnabler`.
Parameters	`osid.id.Id`	`profileEntryEnablerId`	`Id` of a `ProfileEntryEnabler`
Return	`osid.profile.ProfileEntryList`		list of profile entries
Errors	NOT_FOUND		`profileEntryEnablerId` is not found
	NULL_ARGUMENT		`profileEntryEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.