OSID - osid.profile.ProfileManager Service Interface Definition

Interface	osid.profile.ProfileManager
Implements	`osid.OsidManager`
Implements	`osid.profile.ProfileProfile`
Description	The profile manager provides access to profile sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `ProfilingSession:` a session to performs profile checks `ProfileEntryLookupSession:` a session to look up `ProfileEntries` `ProfileEntryQuerySession: a session to query ProfileEntries` `ProfileEntrySearchSession:` a session to search `ProfileEntries` `ProfileEntryAdminSession:` a session to create, modify and delete `ProfileEntries` `ProfileEntryNotificationSession: a` session to receive messages pertaining to `ProfileEntry` changes `ProfileEntryProfileSession:` a session to look up profile entry to profile mappings `ProfileEntryProfileAssignmentSession:` a session to manage profile entry to profile mappings `ProfileEntrySmartProfileSession:` a session to manage smart profile entry profiles `ProfileItemLookupSession:` a session to look up `ProfileItems` `ProfileQuerySearchSession: a session to query ProfileItems` `ProfileItemSearchSession:` a session to search `ProfileItems` `ProfileItemAdminSession:` a session to create, modify and delete `ProfileItems` `ProfileItemNotificationSession: a` session to receive messages pertaining to `ProfileItem` changes `ProfileItemProfileSession:` a session for looking up profile item and profile mappings `ProfileItemProfileAssignmentSession:` a session for managing profile item and profile mappings `ProfileItemSmartProfileSession:` a session to manage smart profile item profiles `ProfileLookupSession:` a session to lookup profiles `ProfileQuerySession:` a session to query profiles `ProfileSearchSession` : a session to search profiles `ProfileAdminSession` : a session to create, modify and delete profiles `ProfileNotificationSession` : a session to receive messages pertaining to `Profile` changes `ProfileHierarchySession` : a session to traverse the `Profile` hierarchy `ProfileHierarchyDesignSession` : a session to manage the `Profile` hierarchy
Method	getProfilingSession
Description	Gets a `ProfilingSession` which is responsible for performing profile checks.
Return	`osid.profile.ProfilingSession`		a profiling session for this service
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfiling()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfiling()` is `true.`
Method	getProfilingSessionForProfile
Description	Gets a `ProfilingSession` which is responsible for performing profile checks for the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the profile
Return	`osid.profile.ProfilingSession`		`a ProfilingSession`
Errors	NOT_FOUND		`profileId`
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsProfiling()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfiling()` and `supportsVisibleFederation()` are `true.`
Method	getProfileEntryLookupSession
Description	Gets the `OsidSession` associated with the profile entry lookup service.
Return	`osid.profile.ProfileEntryLookupSession`		a `ProfileEntryLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntryLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryLookup()` is `true.`
Method	getProfileEntryLookupSessionForProfile
Description	Gets the `OsidSession` associated with the profile entry lookup service for the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the profile
Return	`osid.profile.ProfileEntryLookupSession`		`a ProfileEntryLookupSession`
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsProfileEntryLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryLookup()` and `supportsVisibleFederation()` are `true.`
Method	getProfileEntryQuerySession
Description	Gets the `OsidSession` associated with the profile entry query service.
Return	`osid.profile.ProfileEntryQuerySession`		a `ProfileEntryQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryQuery()` is `true.`
Method	getProfileEntryQuerySessionForProfile
Description	Gets the `OsidSession` associated with the profile entry query service for the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the `Profile`
Return	`osid.profile.ProfileEntryQuerySession`		a `ProfileEntryQuerySession`
Errors	NOT_FOUND		no `Profile` found by the given `Id`
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileEntryQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryQuery()` and `supportsVisibleFederation()` are `true`
Method	getProfileEntrySearchSession
Description	Gets the `OsidSession` associated with the profile entry search service.
Return	`osid.profile.ProfileEntrySearchSession`		a `ProfileEntrySearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntrySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntrySearch()` is `true.`
Method	getProfileEntrySearchSessionForProfile
Description	Gets the `OsidSession` associated with the profile entry search service for the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the profile
Return	`osid.profile.ProfileEntrySearchSession`		`a ProfileEntrySearchSession`
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsProfileEntrySearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntrySearch()` and `supportsVisibleFederation()` are `true.`
Method	getProfileEntryAdminSession
Description	Gets the `OsidSession` associated with the profile entry administration service.
Return	`osid.profile.ProfileEntryAdminSession`		a `ProfileEntryAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntryAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryAdmin()` is `true.`
Method	getProfileEntryAdminSessionForProfile
Description	Gets the `OsidSession` associated with the profile entry admin service for the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the profile
Return	`osid.profile.ProfileEntryAdminSession`		`a ProfileEntryAdminSession`
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsProfileEntryAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getProfileEntryNotificationSession
Description	Gets the notification session for notifications pertaining to profile entry changes.
Parameters	`osid.profile.ProfileEntryReceiver`	`profileEntryReceiver`	the profile entry receiver
Return	`osid.profile.ProfileEntryNotificationSession`		a `ProfileEntryNotificationSession`
Errors	NULL_ARGUMENT		`profileEntryReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileEntryNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryNotification()` is `true.`
Method	getProfileEntryNotificationSessionForProfile
Description	Gets the `OsidSession` associated with the profile entry notification service for the given profile.
Parameters	`osid.profile.ProfileEntryReceiver`	`profileEntryReceiver`	the profile entry receiver
Parameters	`osid.id.Id`	`profileId`	the `Id` of the profile
Return	`osid.profile.ProfileEntryNotificationSession`		`a ProfileEntryNotificationSession`
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileEntryReceiver` or `profileId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsProfileEntryNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryNotification()` and `supportsVisibleFederation()` are `true.`
Method	getProfileEntryProfileSession
Description	Gets the session for retrieving profile entry to profile mappings.
Return	`osid.profile.ProfileEntryProfileSession`		a `ProfileEntryProfileSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntryProfile()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryProfile()` is `true.`
Method	getProfileEntryProfileAssignmentSession
Description	Gets the session for assigning profile entries to profile mappings.
Return	`osid.profile.ProfileEntryProfileAssignmentSession`		a `ProfileEntryProfileAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntryProfileAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryProfileAssignment()` is `true.`
Method	getProfileEntrySmartProfileSession
Description	Gets the session for managing dynamic profile entry profiles.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the profile
Return	`osid.profile.ProfileEntrySmartProfileSession`		a `ProfileEntrySmartProfileSession`
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileEntrySmartProfile()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntrySmartProfile()` is `true.`
Method	getProfileItemLookupSession
Description	Gets the `OsidSession` associated with the profile item lookup service.
Return	`osid.profile.ProfileItemLookupSession`		a `ProfileItemLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileItemLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemLookup()` is `true.`
Method	getProfileItemLookupSessionForProfile
Description	Gets the `OsidSession` associated with the profile item lookup service for the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the profile
Return	`osid.profile.ProfileItemLookupSession`		`a ProfileItemLookupSession`
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsProfileItemLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemLookup()` and `supportsVisibleFederation()` are `true.`
Method	getProfileItemQuerySession
Description	Gets a profile item query session.
Return	`osid.profile.ProfileItemQuerySession`		`a ProfileItemQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileItemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemQuery()` is `true.`
Method	getProfileItemQuerySessionForProfile
Description	Gets a profile item query session for the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the profile
Return	`osid.profile.ProfileItemQuerySession`		`a ProfileItemQuerySession`
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsProfileItemQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemQuery()` and `supportsVisibleFederation()` are `true.`
Method	getProfileItemSearchSession
Description	Gets the `OsidSession` associated with the profile item search service.
Return	`osid.profile.ProfileItemSearchSession`		a `ProfileItemSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileItemSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemSearch()` is `true.`
Method	getProfileItemSearchSessionForProfile
Description	Gets the `OsidSession` associated with the profile item search service for the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the profile
Return	`osid.profile.ProfileItemSearchSession`		a `ProfileItemSearchSession`
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsProfileItemSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemSearch()` and `supportsVisibleFederation()` are `true.`
Method	getProfileItemAdminSession
Description	Gets the `OsidSession` associated with the profile item administration service.
Return	`osid.profile.ProfileItemAdminSession`		a `ProfileItemAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileItemAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemAdmin()` is `true.`
Method	getProfileItemAdminSessionForProfile
Description	Gets the `OsidSession` associated with the profile item admin service for the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the profile
Return	`osid.profile.ProfileItemAdminSession`		`a ProfileItemAdminSession`
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsProfileItemAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getProfileItemNotificationSession
Description	Gets the notification session for notifications pertaining to profile item changes.
Parameters	`osid.profile.ProfileItemReceiver`	`profileItemReceiver`	the profile item receiver
Return	`osid.profile.ProfileItemNotificationSession`		a `ProfileItemNotificationSession`
Errors	NULL_ARGUMENT		`profileItemReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileItemNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemNotification()` is `true.`
Method	getProfileItemNotificationSessionForProfile
Description	Gets the `OsidSession` associated with the profile item notification service for the given profile.
Parameters	`osid.profile.ProfileItemReceiver`	`profileItemReceiver`	the profile item receiver
Parameters	`osid.id.Id`	`profileId`	the `Id` of the profile
Return	`osid.profile.ProfileItemNotificationSession`		`a ProfileItemNotificationSession`
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileItemReceiver` or `profileId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsProfileItemNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemNotification()` and `supportsVisibleFederation()` are `true.`
Method	getProfileItemProfileSession
Description	Gets the session for retrieving profile item to profile mappings.
Return	`osid.profile.ProfileItemProfileSession`		a `ProfileItemProfileSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileItemProfile()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemProfile()` is `true.`
Method	getProfileItemProfileAssignmentSession
Description	Gets the session for assigning profile item to profile mappings.
Return	`osid.profile.ProfileItemProfileSession`		a `ProfileItemProfileAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileItemProfileAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemProfileAssignment()` is `true.`
Method	getProfileItemSmartProfileSession
Description	Gets the session for managing dynamic profile item profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the profile
Return	`osid.profile.ProfileItemSmartProfileSession`		a `ProfileItemSmartProfileSession`
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileItemSmartProfile()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemSmartProfile()` is `true.`
Method	getProfileLookupSession
Description	Gets the OsidSession associated with the profile lookup service.
Return	`osid.profile.ProfileLookupSession`		a `ProfileLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileLookup() is false`
Compliance	`optional`		This method must be implemented if `supportsProfileLookup()` is true.
Method	getProfileQuerySession
Description	Gets the profile query session.
Return	`osid.profile.ProfileQuerySession`		a `ProfileQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileQuery()` is `true.`
Method	getProfileSearchSession
Description	Gets the OsidSession associated with the profile search service.
Return	`osid.profile.ProfileSearchSession`		a `ProfileSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileSearch() is false`
Compliance	`optional`		This method must be implemented if `supportsProfileSearch()` is true.
Method	getProfileAdminSession
Description	Gets the OsidSession associated with the profile administration service.
Return	`osid.profile.ProfileAdminSession`		a `ProfileAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileAdmin() is false`
Compliance	`optional`		This method must be implemented if `supportsProfileAdmin()` is true.
Method	getProfileNotificationSession
Description	Gets the notification session for notifications pertaining to profile service changes.
Parameters	`osid.profile.ProfileReceiver`	`profileReceiver`	the profile receiver
Return	`osid.profile.ProfileNotificationSession`		a `ProfileNotificationSession`
Errors	NULL_ARGUMENT		`profileReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileNotification() is false`
Compliance	`optional`		This method must be implemented if `supportsProfileNotification()` is true.
Method	getProfileHierarchySession
Description	Gets the session traversing profile hierarchies.
Return	`osid.profile.ProfileHierarchySession`		a `ProfileHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileHierarchy() is false`
Compliance	`optional`		This method must be implemented if `supportsProfileHierarchy()` is true.
Method	getProfileHierarchyDesignSession
Description	Gets the session designing profile hierarchies.
Return	`osid.profile.ProfileHierarchyDesignSession`		a `ProfileHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileHierarchyDesign() is false`
Compliance	`optional`		This method must be implemented if `supportsProfileHierarchyDesign()` is true.
Method	getProfileBatchManager
Description	Gets a `ProfileBatchManager.`
Return	`osid.profile.batch.ProfileBatchManager`		a `ProfileBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileBatch() is false`
Compliance	`optional`		This method must be implemented if `supportsProfileBatch()` is true.
Method	getProfileRulesManager
Description	Gets a `ProfileRulesManager.`
Return	`osid.profile.rules.ProfileRulesManager`		a `ProfileRulesManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileRules() is false`
Compliance	`optional`		This method must be implemented if `supportsProfileRules()` is true.