OSID - osid.profile.ProfileItemQuerySession Service Interface Definition

Interface	osid.profile.ProfileItemQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.profile.ProfileItemSearchSession`
Used By	`osid.profile.ProfileManager`
Used By	`osid.profile.ProfileProxyManager`
Description	This session provides methods for searching `ProfileItems`. The search query is constructed using the `ProfileItemQuery`. The profile item record `Type` also specifies the record interface for the profil eitem query. This session defines views that offer differing behaviors for searching. federated profile view: searches include profile item in profiles of which this profile is an ancestor in the profile hierarchy isolated profile view: searches are restricted to profile items in this profile Profile items may have a profile item query record indicated by their respective record types. The profile item query record is accessed via the `ProfileItemQuery` .
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	canSearchProfileItems
Description	Tests if this user can perform `ProfileItem` searches. 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 search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedProfileView
Description	Federates the view for methods in this session. A federated view will include profile items 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 searches to this profile only.
Compliance	`mandatory`		This method is must be implemented.
Method	getProfileItemQuery
Description	Gets a profile item query.
Return	`osid.profile.ProfileItemQuery`		the profile item query
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItemsByQuery
Description	Gets a list of `ProfileItems` matching the given profile item query interface.
Parameters	`osid.profile.ProfileItemQuery`	`profileItemQuery`	the profile item query
Return	`osid.profile.ProfileItemList`		the returned `ProfileItemList`
Errors	NULL_ARGUMENT		`profileItemQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`profileItemQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.