OSID - osid.profile.rules.ProfileRulesManager Service Interface Definition

Interface	osid.profile.rules.ProfileRulesManager
Implements	`osid.OsidManager`
Implements	`osid.profile.rules.ProfileRulesProfile`
Description	The profile rules manager provides access to profile rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `ProfileEntryEnablerLookupSession:` a session to retrieve profile entry enablers `ProfileEntryEnablerQuerySession:` a session to query for profile entry enablers `ProfileEntryEnablerSearchSession:` a session to search for profile entry enablers `ProfileEntryEnablerAdminSession:` a session to create and delete profile entry enablers `ProfileEntryEnablerNotificationSession:` a session to receive notifications pertaining to profile entry enabler changes `ProfileEntryEnablerProfileSession:` a session to look up profile entry enabler profile mappings `ProfileEntryEnablerProfileAssignmentSession:` a session to manage profile entry enabler to profile mappings `ProfileEntryEnablerSmartProfileSession:` a session to manage dynamic profiles of profile entry enablers `ProfileEntryEnablerRuleLookupSession:` a session to look up profile entry enabler to profile entry mappings `ProfileEntryEnablerRuleApplicationSession:` a session to apply profile entry enablers to profile entries
Method	getProfileEntryEnablerLookupSession
Description	Gets the `OsidSession` associated with the profile entry enabler lookup service.
Return	`osid.profile.rules.ProfileEntryEnablerLookupSession`		a `ProfileEntryEnablerLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntryEnablerLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerLookup()` is `true.`
Method	getProfileEntryEnablerLookupSessionForProfile
Description	Gets the `OsidSession` associated with the profile entry enabler lookup service for the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the `Profile`
Return	`osid.profile.rules.ProfileEntryEnablerLookupSession`		a `ProfileEntryEnablerLookupSession`
Errors	NOT_FOUND		no `Profile` found by the given `Id`
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileEntryEnablerLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerLookup()` and `supportsVisibleFederation()` are `true.`
Method	getProfileEntryEnablerQuerySession
Description	Gets the `OsidSession` associated with the profile entry enabler query service.
Return	`osid.profile.rules.ProfileEntryEnablerQuerySession`		a `ProfileEntryEnablerQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntryEnablerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerQuery()` is `true.`
Method	getProfileEntryEnablerQuerySessionForProfile
Description	Gets the `OsidSession` associated with the profile entry enabler query service for the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the `Profile`
Return	`osid.profile.rules.ProfileEntryEnablerQuerySession`		a `ProfileEntryEnablerQuerySession`
Errors	NOT_FOUND		no `Profile` found by the given `Id`
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileEntryEnablerQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerQuery()` and `supportsVisibleFederation()` are `true.`
Method	getProfileEntryEnablerSearchSession
Description	Gets the `OsidSession` associated with the profile entry enabler search service.
Return	`osid.profile.rules.ProfileEntryEnablerSearchSession`		a `ProfileEntryEnablerSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntryEnablerSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerSearch()` is `true.`
Method	getProfileEntryEnablerSearchSessionForProfile
Description	Gets the `OsidSession` associated with the profile entry enablers earch service for the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the `Profile`
Return	`osid.profile.rules.ProfileEntryEnablerSearchSession`		a `ProfileEntryEnablerSearchSession`
Errors	NOT_FOUND		no `Profile` found by the given `Id`
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileEntryEnablerSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerSearch()` and `supportsVisibleFederation()` are `true.`
Method	getProfileEntryEnablerAdminSession
Description	Gets the `OsidSession` associated with the profile entry enabler administration service.
Return	`osid.profile.rules.ProfileEntryEnablerAdminSession`		a `ProfileEntryEnablerAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntryEnablerAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerAdmin()` is `true.`
Method	getProfileEntryEnablerAdminSessionForProfile
Description	Gets the `OsidSession` associated with the profile entry enabler administration service for the given profile.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the `Profile`
Return	`osid.profile.rules.ProfileEntryEnablerAdminSession`		a `ProfileEntryEnablerAdminSession`
Errors	NOT_FOUND		no `Profile` found by the given `Id`
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileEntryEnablerAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getProfileEntryEnablerNotificationSession
Description	Gets the `OsidSession` associated with the profile entry enabler notification service.
Parameters	`osid.profile.rules.ProfileEntryEnablerReceiver`	`profileEntryEnablerReceiver`	the notification callback
Return	`osid.profile.rules.ProfileEntryEnablerNotificationSession`		a `ProfileEntryEnablerNotificationSession`
Errors	NULL_ARGUMENT		`profileEntryEnablerReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileEntryEnablerNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerNotification()` is `true.`
Method	getProfileEntryEnablerNotificationSessionForProfile
Description	Gets the `OsidSession` associated with the profile entry enabler notification service for the given profile.
Parameters	`osid.profile.rules.ProfileEntryEnablerReceiver`	`profileEntryEnablerReceiver`	the notification callback
Parameters	`osid.id.Id`	`profileId`	the `Id` of the `Profile`
Return	`osid.profile.rules.ProfileEntryEnablerNotificationSession`		a `ProfileEntryEnablerNotificationSession`
Errors	NOT_FOUND		no profile found by the given `Id`
	NULL_ARGUMENT		`profileEntryEnablerReceiver` or `profileId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileEntryEnablerNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerNotification()` and `supportsVisibleFederation()` are `true.`
Method	getProfileEntryEnablerProfileSession
Description	Gets the `OsidSession` to lookup profile entry enabler/profile mappings for profile entry enablers.
Return	`osid.profile.rules.ProfileEntryEnablerProfileSession`		a `ProfileEntryEnablerProfileSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntryEnablerProfile()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerProfile()` is `true.`
Method	getProfileEntryEnablerProfileAssignmentSession
Description	Gets the `OsidSession` associated with assigning profile entry enablers to profiles for profile entry.
Return	`osid.profile.rules.ProfileEntryEnablerProfileAssignmentSession`		a `ProfileEntryEnablerProfileAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntryEnablerProfileAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerProfileAssignment()` is `true.`
Method	getProfileEntryEnablerSmartProfileSession
Description	Gets the `OsidSession` to manage profile entry enabler smart profiles.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the `Profile`
Return	`osid.profile.rules.ProfileEntryEnablerSmartProfileSession`		a `ProfileEntryEnablerSmartProfileSession`
Errors	NOT_FOUND		no `Profile` found by the given `Id`
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileEntryEnablerSmartProfile()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerSmartProfile()` is `true.`
Method	getProfileEntryEnablerRuleLookupSession
Description	Gets the `OsidSession` associated with the profile entry enabler mapping lookup service for looking up the rules applied to a profile entry.
Return	`osid.profile.rules.ProfileEntryEnablerRuleLookupSession`		a `ProfileEntryEnablerRuleSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntryEnablerRuleLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerRuleLookup()` is `true.`
Method	getProfileEntryEnablerRuleLookupSessionForProfile
Description	Gets the `OsidSession` associated with the profile entry enabler mapping lookup service for the given profile for looking up rules applied to a profile entry.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the `Profile`
Return	`osid.profile.rules.ProfileEntryEnablerRuleLookupSession`		a `ProfileEntryEnablerRuleLookupSession`
Errors	NOT_FOUND		no `Profile` found by the given `Id`
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileEntryEnablerRuleLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerRuleLookup()` and `supportsVisibleFederation()` are `true.`
Method	getProfileEntryEnablerRuleApplicationSession
Description	Gets the `OsidSession` associated with the profile entry enabler assignment service to apply enablers to profile entries.
Return	`osid.profile.rules.ProfileEntryEnablerRuleApplicationSession`		a `ProfileEntryEnablerRuleApplicationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProfileEntryEnablerRuleApplication()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerRuleApplication()` is `true.`
Method	getProfileEntryEnablerRuleApplicationSessionForProfile
Description	Gets the `OsidSession` associated with the profile entry enabler assignment service for the given profile to apply enablers to profile entries.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the `Profile`
Return	`osid.profile.rules.ProfileEntryEnablerRuleApplicationSession`		a `ProfileEntryEnablerRuleApplicationSession`
Errors	NOT_FOUND		no `Profile` found by the given `Id`
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProfileEntryEnablerRuleApplication()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileEntryEnablerRuleApplication()` and `supportsVisibleFederation()` are `true.`