org.osid.profile.rules

Interface ProfileRulesManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, ProfileRulesProfile, Sourceable

public interface ProfileRulesManager
extends OsidManager, ProfileRulesProfile

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 Summary

Methods

Modifier and Type	Method and Description
ProfileEntryEnablerAdminSession	getProfileEntryEnablerAdminSession() Gets the OsidSession associated with the profile entry enabler administration service.
ProfileEntryEnablerAdminSession	getProfileEntryEnablerAdminSessionForProfile(Id profileId) Gets the OsidSession associated with the profile entry enabler administration service for the given profile.
ProfileEntryEnablerLookupSession	getProfileEntryEnablerLookupSession() Gets the OsidSession associated with the profile entry enabler lookup service.
ProfileEntryEnablerLookupSession	getProfileEntryEnablerLookupSessionForProfile(Id profileId) Gets the OsidSession associated with the profile entry enabler lookup service for the given profile.
ProfileEntryEnablerNotificationSession	getProfileEntryEnablerNotificationSession(ProfileEntryEnablerReceiver profileEntryEnablerReceiver) Gets the OsidSession associated with the profile entry enabler notification service.
ProfileEntryEnablerNotificationSession	getProfileEntryEnablerNotificationSessionForProfile(ProfileEntryEnablerReceiver profileEntryEnablerReceiver, Id profileId) Gets the OsidSession associated with the profile entry enabler notification service for the given profile.
ProfileEntryEnablerProfileAssignmentSession	getProfileEntryEnablerProfileAssignmentSession() Gets the OsidSession associated with assigning profile entry enablers to profiles for profile entry.
ProfileEntryEnablerProfileSession	getProfileEntryEnablerProfileSession() Gets the OsidSession to lookup profile entry enabler/profile mappings for profile entry enablers.
ProfileEntryEnablerQuerySession	getProfileEntryEnablerQuerySession() Gets the OsidSession associated with the profile entry enabler query service.
ProfileEntryEnablerQuerySession	getProfileEntryEnablerQuerySessionForProfile(Id profileId) Gets the OsidSession associated with the profile entry enabler query service for the given profile.
ProfileEntryEnablerRuleApplicationSession	getProfileEntryEnablerRuleApplicationSession() Gets the OsidSession associated with the profile entry enabler assignment service to apply enablers to profile entries.
ProfileEntryEnablerRuleApplicationSession	getProfileEntryEnablerRuleApplicationSessionForProfile(Id profileId) Gets the OsidSession associated with the profile entry enabler assignment service for the given profile to apply enablers to profile entries.
ProfileEntryEnablerRuleLookupSession	getProfileEntryEnablerRuleLookupSession() Gets the OsidSession associated with the profile entry enabler mapping lookup service for looking up the rules applied to a profile entry.
ProfileEntryEnablerRuleLookupSession	getProfileEntryEnablerRuleLookupSessionForProfile(Id profileId) 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.
ProfileEntryEnablerSearchSession	getProfileEntryEnablerSearchSession() Gets the OsidSession associated with the profile entry enabler search service.
ProfileEntryEnablerSearchSession	getProfileEntryEnablerSearchSessionForProfile(Id profileId) Gets the OsidSession associated with the profile entry enablers earch service for the given profile.
ProfileEntryEnablerSmartProfileSession	getProfileEntryEnablerSmartProfileSession(Id profileId) Gets the OsidSession to manage profile entry enabler smart profiles.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.profile.rules.ProfileRulesProfile

getProfileEntryEnablerRecordTypes, getProfileEntryEnablerSearchRecordTypes, supportsProfileEntryEnablerAdmin, supportsProfileEntryEnablerLookup, supportsProfileEntryEnablerNotification, supportsProfileEntryEnablerProfile, supportsProfileEntryEnablerProfileAssignment, supportsProfileEntryEnablerQuery, supportsProfileEntryEnablerRecordType, supportsProfileEntryEnablerRuleApplication, supportsProfileEntryEnablerRuleLookup, supportsProfileEntryEnablerSearch, supportsProfileEntryEnablerSearchRecordType, supportsProfileEntryEnablerSmartProfile, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getProfileEntryEnablerLookupSession

ProfileEntryEnablerLookupSession getProfileEntryEnablerLookupSession()
                                                                     throws OperationFailedException

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

Returns:

a ProfileEntryEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerLookup() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerLookup() is true.

getProfileEntryEnablerLookupSessionForProfile

ProfileEntryEnablerLookupSession getProfileEntryEnablerLookupSessionForProfile(Id profileId)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

profileId - the Id of the Profile

Returns:

a ProfileEntryEnablerLookupSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerLookup() and supportsVisibleFederation() are true.

getProfileEntryEnablerQuerySession

ProfileEntryEnablerQuerySession getProfileEntryEnablerQuerySession()
                                                                   throws OperationFailedException

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

Returns:

a ProfileEntryEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerQuery() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerQuery() is true.

getProfileEntryEnablerQuerySessionForProfile

ProfileEntryEnablerQuerySession getProfileEntryEnablerQuerySessionForProfile(Id profileId)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

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

Parameters:

profileId - the Id of the Profile

Returns:

a ProfileEntryEnablerQuerySession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerQuery() and supportsVisibleFederation() are true.

getProfileEntryEnablerSearchSession

ProfileEntryEnablerSearchSession getProfileEntryEnablerSearchSession()
                                                                     throws OperationFailedException

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

Returns:

a ProfileEntryEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerSearch() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerSearch() is true.

getProfileEntryEnablerSearchSessionForProfile

ProfileEntryEnablerSearchSession getProfileEntryEnablerSearchSessionForProfile(Id profileId)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

profileId - the Id of the Profile

Returns:

a ProfileEntryEnablerSearchSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerSearch() and supportsVisibleFederation() are true.

getProfileEntryEnablerAdminSession

ProfileEntryEnablerAdminSession getProfileEntryEnablerAdminSession()
                                                                   throws OperationFailedException

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

Returns:

a ProfileEntryEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerAdmin() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerAdmin() is true.

getProfileEntryEnablerAdminSessionForProfile

ProfileEntryEnablerAdminSession getProfileEntryEnablerAdminSessionForProfile(Id profileId)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

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

Parameters:

profileId - the Id of the Profile

Returns:

a ProfileEntryEnablerAdminSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerAdmin() and supportsVisibleFederation() are true.

getProfileEntryEnablerNotificationSession

ProfileEntryEnablerNotificationSession getProfileEntryEnablerNotificationSession(ProfileEntryEnablerReceiver profileEntryEnablerReceiver)
                                                                                 throws OperationFailedException

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

Parameters:

profileEntryEnablerReceiver - the notification callback

Returns:

a ProfileEntryEnablerNotificationSession

Throws:

NullArgumentException - profileEntryEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerNotification() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerNotification() is true.

getProfileEntryEnablerNotificationSessionForProfile

ProfileEntryEnablerNotificationSession getProfileEntryEnablerNotificationSessionForProfile(ProfileEntryEnablerReceiver profileEntryEnablerReceiver,
                                                                                         Id profileId)
                                                                                           throws NotFoundException,
                                                                                                  OperationFailedException

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

Parameters:

profileEntryEnablerReceiver - the notification callback

profileId - the Id of the Profile

Returns:

a ProfileEntryEnablerNotificationSession

Throws:

NotFoundException - no profile found by the given Id

NullArgumentException - profileEntryEnablerReceiver or profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerNotification() and supportsVisibleFederation() are true.

getProfileEntryEnablerProfileSession

ProfileEntryEnablerProfileSession getProfileEntryEnablerProfileSession()
                                                                       throws OperationFailedException

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

Returns:

a ProfileEntryEnablerProfileSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerProfile() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerProfile() is true.

getProfileEntryEnablerProfileAssignmentSession

ProfileEntryEnablerProfileAssignmentSession getProfileEntryEnablerProfileAssignmentSession()
                                                                                           throws OperationFailedException

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

Returns:

a ProfileEntryEnablerProfileAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerProfileAssignment() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerProfileAssignment() is true.

getProfileEntryEnablerSmartProfileSession

ProfileEntryEnablerSmartProfileSession getProfileEntryEnablerSmartProfileSession(Id profileId)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

Gets the OsidSession to manage profile entry enabler smart profiles.

Parameters:

profileId - the Id of the Profile

Returns:

a ProfileEntryEnablerSmartProfileSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerSmartProfile() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerSmartProfile() is true.

getProfileEntryEnablerRuleLookupSession

ProfileEntryEnablerRuleLookupSession getProfileEntryEnablerRuleLookupSession()
                                                                             throws OperationFailedException

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

Returns:

a ProfileEntryEnablerRuleSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerRuleLookup() is true.

getProfileEntryEnablerRuleLookupSessionForProfile

ProfileEntryEnablerRuleLookupSession getProfileEntryEnablerRuleLookupSessionForProfile(Id profileId)
                                                                                       throws NotFoundException,
                                                                                              OperationFailedException

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:

profileId - the Id of the Profile

Returns:

a ProfileEntryEnablerRuleLookupSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerRuleLookup() and supportsVisibleFederation() are true.

getProfileEntryEnablerRuleApplicationSession

ProfileEntryEnablerRuleApplicationSession getProfileEntryEnablerRuleApplicationSession()
                                                                                       throws OperationFailedException

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

Returns:

a ProfileEntryEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerRuleApplication() is true.

getProfileEntryEnablerRuleApplicationSessionForProfile

ProfileEntryEnablerRuleApplicationSession getProfileEntryEnablerRuleApplicationSessionForProfile(Id profileId)
                                                                                                 throws NotFoundException,
                                                                                                        OperationFailedException

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

Parameters:

profileId - the Id of the Profile

Returns:

a ProfileEntryEnablerRuleApplicationSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProfileEntryEnablerRuleApplication() and supportsVisibleFederation() are true.