OSID - osid.profile.ProfileEntrySmartProfileSession Service Interface Definition

Interface	osid.profile.ProfileEntrySmartProfileSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ProfileEntryQuery` can be retrieved from this session and mapped to this `Profile` to create a virtual collection of profile entries. The profile entries may be sequenced using the `ProfileEntrySearchOrder` from this session. This `Profile` has a default query that matches any profile Item and a default search order that specifies no sequencing. The queries may be examined using a `ProfileEntryQueryInspector.` The query may be modified by converting the inspector back to a `ProfileEntryQuery.`
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 profiles. 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	getProfileEntryQuery
Description	Gets a profile entry query.
Return	`osid.profile.ProfileEntryQuery`		the profile entry query
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntrySearchOrder
Description	Gets a profile entry search order.
Return	`osid.profile.ProfileEntrySearchOrder`		the profile entry search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProfileEntryQuery
Description	Applies a profile entry query to this profile.
Parameters	`osid.profile.ProfileEntryQuery`	`profileEntryQuery`	the profile entry query
Errors	NULL_ARGUMENT		`profileEntryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`profileEntryQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProfileEntryQuery
Description	Gets a profile entry query inspector for this profile.
Return	`osid.profile.ProfileEntryQueryInspector`		the profile entry query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProfileEntrySequencing
Description	Applies a profile entry search order to this profile.
Parameters	`osid.profile.ProfileEntrySearchOrder`	`profileEntrySearchOrder`	the profile entry search order
Errors	NULL_ARGUMENT		`profileEntrySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`profileEntrySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryQueryFromInspector
Description	Gets a profile entry query from an inspector.
Parameters	`osid.profile.ProfileEntryQueryInspector`	`profileEntryQueryInspector`	a profile entry query inspector
Return	`osid.profile.ProfileItemQuery`		the profile entry query
Errors	NULL_ARGUMENT		`profileEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`profileEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.