OSID Logo
OSID Specifications
profile rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.rules.ProfileRulesManager
Implementsosid.OsidManager
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
MethodgetProfileEntryEnablerLookupSession
Description

Gets the OsidSession associated with the profile entry enabler lookup service.

Returnosid.profile.rules.ProfileEntryEnablerLookupSessiona ProfileEntryEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerLookup() is true.
MethodgetProfileEntryEnablerLookupSessionForProfile
Description

Gets the OsidSession associated with the profile entry enabler lookup service for the given profile.

Parametersosid.id.IdprofileIdthe Id of the Profile
Returnosid.profile.rules.ProfileEntryEnablerLookupSessiona ProfileEntryEnablerLookupSession
ErrorsNOT_FOUNDno Profile found by the given Id
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerLookup() and supportsVisibleFederation() are true.
MethodgetProfileEntryEnablerQuerySession
Description

Gets the OsidSession associated with the profile entry enabler query service.

Returnosid.profile.rules.ProfileEntryEnablerQuerySessiona ProfileEntryEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerQuery() is true.
MethodgetProfileEntryEnablerQuerySessionForProfile
Description

Gets the OsidSession associated with the profile entry enabler query service for the given profile.

Parametersosid.id.IdprofileIdthe Id of the Profile
Returnosid.profile.rules.ProfileEntryEnablerQuerySessiona ProfileEntryEnablerQuerySession
ErrorsNOT_FOUNDno Profile found by the given Id
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerQuery() and supportsVisibleFederation() are true.
MethodgetProfileEntryEnablerSearchSession
Description

Gets the OsidSession associated with the profile entry enabler search service.

Returnosid.profile.rules.ProfileEntryEnablerSearchSessiona ProfileEntryEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerSearch() is true.
MethodgetProfileEntryEnablerSearchSessionForProfile
Description

Gets the OsidSession associated with the profile entry enablers earch service for the given profile.

Parametersosid.id.IdprofileIdthe Id of the Profile
Returnosid.profile.rules.ProfileEntryEnablerSearchSessiona ProfileEntryEnablerSearchSession
ErrorsNOT_FOUNDno Profile found by the given Id
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerSearch() and supportsVisibleFederation() are true.
MethodgetProfileEntryEnablerAdminSession
Description

Gets the OsidSession associated with the profile entry enabler administration service.

Returnosid.profile.rules.ProfileEntryEnablerAdminSessiona ProfileEntryEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerAdmin() is true.
MethodgetProfileEntryEnablerAdminSessionForProfile
Description

Gets the OsidSession associated with the profile entry enabler administration service for the given profile.

Parametersosid.id.IdprofileIdthe Id of the Profile
Returnosid.profile.rules.ProfileEntryEnablerAdminSessiona ProfileEntryEnablerAdminSession
ErrorsNOT_FOUNDno Profile found by the given Id
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetProfileEntryEnablerNotificationSession
Description

Gets the OsidSession associated with the profile entry enabler notification service.

Parametersosid.profile.rules.ProfileEntryEnablerReceiverprofileEntryEnablerReceiverthe notification callback
Returnosid.profile.rules.ProfileEntryEnablerNotificationSessiona ProfileEntryEnablerNotificationSession
ErrorsNULL_ARGUMENT profileEntryEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerNotification() is true.
MethodgetProfileEntryEnablerNotificationSessionForProfile
Description

Gets the OsidSession associated with the profile entry enabler notification service for the given profile.

Parametersosid.profile.rules.ProfileEntryEnablerReceiverprofileEntryEnablerReceiverthe notification callback
osid.id.IdprofileIdthe Id of the Profile
Returnosid.profile.rules.ProfileEntryEnablerNotificationSessiona ProfileEntryEnablerNotificationSession
ErrorsNOT_FOUNDno profile found by the given Id
NULL_ARGUMENT profileEntryEnablerReceiver or profileId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerNotification() and supportsVisibleFederation() are true.
MethodgetProfileEntryEnablerProfileSession
Description

Gets the OsidSession to lookup profile entry enabler/profile mappings for profile entry enablers.

Returnosid.profile.rules.ProfileEntryEnablerProfileSessiona ProfileEntryEnablerProfileSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerProfile() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerProfile() is true.
MethodgetProfileEntryEnablerProfileAssignmentSession
Description

Gets the OsidSession associated with assigning profile entry enablers to profiles for profile entry.

Returnosid.profile.rules.ProfileEntryEnablerProfileAssignmentSessiona ProfileEntryEnablerProfileAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerProfileAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerProfileAssignment() is true.
MethodgetProfileEntryEnablerSmartProfileSession
Description

Gets the OsidSession to manage profile entry enabler smart profiles.

Parametersosid.id.IdprofileIdthe Id of the Profile
Returnosid.profile.rules.ProfileEntryEnablerSmartProfileSessiona ProfileEntryEnablerSmartProfileSession
ErrorsNOT_FOUNDno Profile found by the given Id
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerSmartProfile() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerSmartProfile() is true.
MethodgetProfileEntryEnablerRuleLookupSession
Description

Gets the OsidSession associated with the profile entry enabler mapping lookup service for looking up the rules applied to a profile entry.

Returnosid.profile.rules.ProfileEntryEnablerRuleLookupSessiona ProfileEntryEnablerRuleSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerRuleLookup() is true.
MethodgetProfileEntryEnablerRuleLookupSessionForProfile
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.

Parametersosid.id.IdprofileIdthe Id of the Profile
Returnosid.profile.rules.ProfileEntryEnablerRuleLookupSessiona ProfileEntryEnablerRuleLookupSession
ErrorsNOT_FOUNDno Profile found by the given Id
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetProfileEntryEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the profile entry enabler assignment service to apply enablers to profile entries.

Returnosid.profile.rules.ProfileEntryEnablerRuleApplicationSessiona ProfileEntryEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerRuleApplication() is true.
MethodgetProfileEntryEnablerRuleApplicationSessionForProfile
Description

Gets the OsidSession associated with the profile entry enabler assignment service for the given profile to apply enablers to profile entries.

Parametersosid.id.IdprofileIdthe Id of the Profile
Returnosid.profile.rules.ProfileEntryEnablerRuleApplicationSessiona ProfileEntryEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Profile found by the given Id
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryEnablerRuleApplication() and supportsVisibleFederation() are true.