OSID - osid.profile.ProfileItemSmartProfileSession Service Interface Definition

Interface	osid.profile.ProfileItemSmartProfileSession
Implements	`osid.OsidSession`
Used By	`osid.profile.ProfileManager`
Used By	`osid.profile.ProfileProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ProfileItemQuery` can be retrieved from this session and mapped to this `Profile` to create a virtual collection of `ProfileItems` . The profile Items may be sequenced using the `ProfileItemSearchOrder` from this session. This `Profile` has a default query that matches any profileItem and a default search order that specifies no sequencing. The queries may be examined using a `ProfileItemQueryInspector` . The query may be modified by converting the inspector back to a `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	canManageSmartProfiles
Description	Tests if this user can manage smart profile. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart profile management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getProfileItemSearchOrder
Description	Gets a profile item search order.
Return	`osid.profile.ProfileItemSearchOrder`		the profile item search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProfileItemQuery
Description	Applies a profile item query to this profile.
Parameters	`osid.profile.ProfileItemQuery`	`profileItemQuery`	the profile item query
Errors	NULL_ARGUMENT		`profileItemQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`profileItemQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProfileItemQuery
Description	Gets a profile item query inspector for this profile.
Return	`osid.profile.ProfileItemQueryInspector`		the profile item query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProfileItemSequencing
Description	Applies a profile item search order to this profile.
Parameters	`osid.profile.ProfileItemSearchOrder`	`profileItemSearchOrder`	the profile item search order
Errors	NULL_ARGUMENT		`profileItemSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`profileItemSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItemQueryFromInspector
Description	Gets a profile item query from an inspector.
Parameters	`osid.profile.ProfileItemQueryInspector`	`profileItemQueryInspector`	a profile item query inspector
Return	`osid.profile.ProfileItemQuery`		the profile item query
Errors	NULL_ARGUMENT		`profileItemQueryInspector` is `null`
Errors	UNSUPPORTED		`profileItemQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.