OSID - osid.profile.ProfileEntryLookupSession Service Interface Definition

Interface	osid.profile.ProfileEntryLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods to search and retrieve `ProfileEntry` mappings. This lookup session defines two sets of views: isolated profile view: All profile methods in this session operate, retrieve and pertain to `ProfileEntries` defined explicitly in the current `Profile.` Using an isolated view is useful for managing `ProfileEntries` with the `ProfileEntryAdminSession.` federated profile view; All profile methods in this session operate, retrieve and pertain to all profile entries defined in this profile and any other entries implicitly available in this profile through profile inheritence. effective profile entry view: All profil eentry lookup methods return edges where the current dates falls in between the effective dates inclusive. any effective profile entry edge view: Profil eentries of any effective date are returned. explicit profile entry view: All profile methods in this session operate, retrieve and pertain to only those profile entries that have been explicitly defined and not derived from `Resource` groups. implicit profile entry view; All profile entry methods in this session operate, retrieve and pertain to all profile entries including those derived from `Resource` groups. explicit resource view: Only show profile entries explicitly mapped to the given resource when looking up profile entries by resource. implicit resource view: Include all profile entries related to the resource including profile entries using any agent of the resource. The view methods such as `useExplicitProfileEntryView()` and `useImplicitProfileEntryView()` behave as a radio group and one should be selected before invoking any lookup methods.
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupProfileEntries
Description	Tests if this user can perform profile 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	useComparativeProfileEntryView
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	usePlenaryProfileEntryView
Description	A complete view of the `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 entries 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	useEffectiveProfileEntryView
Description	Only profile entries whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveProfileEntryView
Description	All profile entries of any effective dates are returned by all methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useImplicitProfileEntryView
Description	Sets the view for methods in this session to implicit profile entries. An implicit view will include profile entries derived from other entries as a result of the `ProfileItem` or `Resource` hierarchies. This method is the opposite of `explicitProfileEntryView().`
Compliance	`mandatory`		This method is must be implemented.
Method	useExplicitProfileEntryView
Description	Sets the view for methods in this session to explicit profile entries. An explicit view includes only those profile entries that were explicitly defined and not implied. This method is the opposite of `implicitProfileEntryView().`
Compliance	`mandatory`		This method is must be implemented.
Method	useImplicitResourceView
Description	Include profile entries of any agent of a resource when looking up profile entries by resource.
Compliance	`mandatory`		This method is must be implemented.
Method	useExplicitResourceView
Description	Only include profile entries explicitly mapped to the given resource when looking up profile entries by resource.
Compliance	`mandatory`		This method is must be implemented.
Method	getProfileEntry
Description	Gets the `ProfileEntry` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `ProfileEntry` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `ProfileEntry` and retained for compatibility. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.id.Id`	`profileEntryId`	the `Id` of the `ProfileEntry` to retrieve
Return	`osid.profile.ProfileEntry`		the returned `ProfileEntry`
Errors	NOT_FOUND		no `ProfileEntry` found with the given `Id`
	NULL_ARGUMENT		`profileEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesByIds
Description	Gets an `ProfileEntryList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the entries 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 `ProfileEntries` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.id.IdList`	`profileEntryIds`	the list of `Ids` to retrieve
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`profileEntryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesByGenusType
Description	Gets a `ProfileEntryList` corresponding to the given profile entry genus `Type` which does not include profile entries of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known profile entries or an error results. Otherwise, the returned list may contain only those profile ebtries that are accessible through this session. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.type.Type`	`profileEntryGenusType`	a profile entry genus type
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry` list
Errors	NULL_ARGUMENT		`profileEntryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesByParentGenusType
Description	Gets a `ProfileEntryList` corresponding to the given profile entry genus `Type and` include profile entries of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known profile entries or an error results. Otherwise, the returned list may contain only those profile ebtries that are accessible through this session. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.type.Type`	`profileEntryGenusType`	a profile entry genus type
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry` list
Errors	NULL_ARGUMENT		`profileEntryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesByRecordType
Description	Gets a `ProfileEntryList` containing the given profile entry record `Type.` In plenary mode, the returned list contains all known profile entries or an error results. Otherwise, the returned list may contain only those profile entries that are accessible through this session. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.type.Type`	`profileEntryRecordType`	a profile entry record type
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry` list
Errors	NULL_ARGUMENT		`profileEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesOnDate
Description	Gets a `ProfileEntryList` effective date during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, profile entries are returned that are currently effective in addition to being effective durting the date range. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry` 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 occurred
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesForResource
Description	Gets a list of `ProfileEntries` associated for entries related to a given resource. In explicit resource view, only include entries with the given resource. In implicit resource view, also include entries using any agent of the given resource. In plenary mode, the returned list contains all known profile entries or an error results. Otherwise, the returned list may contain only those profile ebtries that are accessible through this session. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry list`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesForResourceOnDate
Description	Gets a `ProfileEntryList` for entries explicitly mapped to a given resource and effective during the entire given date range inclusive but not confined to the date range. In explicit resource view, only include entries with the given resource. In implicit resource view, also include entries using any agent of the given resource. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesForAgent
Description	Gets a list of `ProfileEntries` associated with a given agent. In plenary mode, the returned list contains all known profile entries or an error results. Otherwise, the returned list may contain only those profile ebtries that are accessible through this session. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry list`
Errors	NULL_ARGUMENT		`agentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesForAgentOnDate
Description	Gets a `ProfileEntryList` for the given agent and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, profile entries are returned that are currently effective in addition to being effective during the date range. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry` 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 occurred
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesForProfileItem
Description	Gets a `ProfileEntryList` for a given profile item. In plenary mode, the returned list contains all known profile entries or an error results. Otherwise, the returned list may contain only those profile entries that are accessible through this session. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.id.Id`	`profileItemId`	a profile item `Id`
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry list`
Errors	NULL_ARGUMENT		`profileItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesForProfileItemOnDate
Description	Gets a `ProfileEntryList` for the given profile item and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, profile entries are returned that are currently effectiv in addition to being effective during the date range. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.id.Id`	`profileItemId`	a profile item `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`profileItemId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesForResourceAndProfileItem
Description	Gets a list of `ProfileEntries` associated for entries explicitly mapped to a given resource and profile item. In explicit resource view, only include entries with the given resource. In implicit resource view, also include entries using any agent of the given resource. In plenary mode, the returned list contains all known profile entries or an error results. Otherwise, the returned list may contain only those profile ebtries that are accessible through this session. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.id.Id`	`profileItemId`	a profile item `Id`
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry list`
Errors	NULL_ARGUMENT		`resourceId` or `profileItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesForResourceAndProfileItemOnDate
Description	Gets a `ProfileEntryList` for entries explicitly mapped to a given resource and profile item and effective during the entire given date range inclusive but not confined to the date range. In explicit resource view, only include entries with the given resource. In implicit resource view, also include entries using any agent of the given resource. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`profileItemId`	a profile item `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, profileItemId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesForAgentAndProfileItem
Description	Gets a list of `ProfileEntries` associated for entries explicitly mapped to a given agent and profile item. In plenary mode, the returned list contains all known profile entries or an error results. Otherwise, the returned list may contain only those profile ebtries that are accessible through this session. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Parameters	`osid.id.Id`	`profileItemId`	a profile item `Id`
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry list`
Errors	NULL_ARGUMENT		`agentId` or `profileItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesForAgentAndProfileItemOnDate
Description	Gets a `ProfileEntryList` for entries explicitly mapped to a given agent and profile item and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.id.Id`	`profileItemId`	a profile item `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.profile.ProfileEntryList`		the returned `ProfileEntry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, profileItemId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getExplicitProfileEntry
Description	Gets the explicit `ProfileEntry` that generated the given implicit profile entry. If the given `ProfileEntry` is explicit, then the same `ProfileEntry` is returned.
Parameters	`osid.id.Id`	`profileEntryId`	a profile entry
Return	`osid.profile.ProfileEntry`		the explicit `ProfileEntry`
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	getProfileEntries
Description	Geta all `ProfileEntries.` In plenary mode, the returned list contains all known profile entries or an error results. Otherwise, the returned list may contain only those profile ebtries that are accessible through this session. In effective mode, profile entries are returned that are currently effective. In any effective mode, effective profile entries and those currently expired are returned.
Return	`osid.profile.ProfileEntryList`		a list of `ProfileEntries`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.