org.osid.profile.rules

Interface ProfileRulesProxyManager

All Superinterfaces:

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

public interface ProfileRulesProxyManager
extends OsidProxyManager, ProfileRulesProfile

The profile rules proxy manager provides access to profile rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. 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(Proxy proxy) Gets the OsidSession associated with the profile entry enabler administration service.
ProfileEntryEnablerAdminSession	getProfileEntryEnablerAdminSessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the profile entry enabler administration service for the given profile.
ProfileEntryEnablerLookupSession	getProfileEntryEnablerLookupSession(Proxy proxy) Gets the OsidSession associated with the profile entry enabler lookup service.
ProfileEntryEnablerLookupSession	getProfileEntryEnablerLookupSessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the profile entry enabler lookup service for the given profile.
ProfileEntryEnablerNotificationSession	getProfileEntryEnablerNotificationSession(ProfileEntryEnablerReceiver profileEntryEnablerReceiver, Proxy proxy) Gets the OsidSession associated with the profile entry enabler notification service.
ProfileEntryEnablerNotificationSession	getProfileEntryEnablerNotificationSessionForProfile(ProfileEntryEnablerReceiver profileEntryEnablerReceiver, Id profileId, Proxy proxy) Gets the OsidSession associated with the profile entry enabler notification service for the given profile.
ProfileEntryEnablerProfileAssignmentSession	getProfileEntryEnablerProfileAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning profile entry enablers to profiles for profile entry.
ProfileEntryEnablerProfileSession	getProfileEntryEnablerProfileSession(Proxy proxy) Gets the OsidSession to lookup profile entry enabler/profile mappings for profile entry enablers.
ProfileEntryEnablerQuerySession	getProfileEntryEnablerQuerySession(Proxy proxy) Gets the OsidSession associated with the profile entry enabler query service.
ProfileEntryEnablerQuerySession	getProfileEntryEnablerQuerySessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the profile entry enabler query service for the given profile.
ProfileEntryEnablerRuleApplicationSession	getProfileEntryEnablerRuleApplicationSession(Proxy proxy) Gets the OsidSession associated with the profile entry enabler assignment service to apply enablers to profiles.
ProfileEntryEnablerRuleApplicationSession	getProfileEntryEnablerRuleApplicationSessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the profile entry enabler assignment service for the given profile to apply enablers to profiles.
ProfileEntryEnablerRuleLookupSession	getProfileEntryEnablerRuleLookupSession(Proxy proxy) Gets the OsidSession associated with the profile entry enabler mapping lookup service for looking up the rules applied to the profile.
ProfileEntryEnablerRuleLookupSession	getProfileEntryEnablerRuleLookupSessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the profile entry enabler mapping lookup service for the given profile for looking up rules applied to a profile.
ProfileEntryEnablerSearchSession	getProfileEntryEnablerSearchSession(Proxy proxy) Gets the OsidSession associated with the profile entry enabler search service.
ProfileEntryEnablerSearchSession	getProfileEntryEnablerSearchSessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the profile entry enablers earch service for the given profile.
ProfileEntryEnablerSmartProfileSession	getProfileEntryEnablerSmartProfileSession(Id profileId, Proxy proxy) Gets the OsidSession to manage profile entry enabler smart profiles.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                                     throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                                             Proxy proxy)
                                                                               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

proxy - a proxy

Returns:

a ProfileEntryEnablerLookupSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy 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(Proxy proxy)
                                                                   throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                                           Proxy proxy)
                                                                             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

proxy - a proxy

Returns:

a ProfileEntryEnablerQuerySession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy 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(Proxy proxy)
                                                                     throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                                             Proxy proxy)
                                                                               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

proxy - a proxy

Returns:

a ProfileEntryEnablerSearchSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy 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(Proxy proxy)
                                                                   throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                           Proxy proxy)
                                                                             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

proxy - a proxy

Returns:

a ProfileEntryEnablerAdminSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy 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,
                                                                               Proxy proxy)
                                                                                 throws OperationFailedException

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

Parameters:

profileEntryEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a ProfileEntryEnablerNotificationSession

Throws:

NullArgumentException - profileEntryEnablerReceiver or proxy 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,
                                                                                         Proxy proxy)
                                                                                           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

proxy - a proxy

Returns:

a ProfileEntryEnablerNotificationSession

Throws:

NotFoundException - no profile found by the given Id

NullArgumentException - profileEntryEnablerReceiver, profileId or proxy 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(Proxy proxy)
                                                                       throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerProfileSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerProfile() is false

Compliance:

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

getProfileEntryEnablerProfileAssignmentSession

ProfileEntryEnablerProfileAssignmentSession getProfileEntryEnablerProfileAssignmentSession(Proxy proxy)
                                                                                           throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerProfileAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                                               Proxy proxy)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

Gets the OsidSession to manage profile entry enabler smart profiles.

Parameters:

profileId - the Id of the Profile

proxy - a proxy

Returns:

a ProfileEntryEnablerSmartProfileSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy 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(Proxy proxy)
                                                                             throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                                                     Proxy proxy)
                                                                                       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.

Parameters:

profileId - the Id of the Profile

proxy - a proxy

Returns:

a ProfileEntryEnablerRuleLookupSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnableRuleLookup() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryEnablerRuleApplicationSession

ProfileEntryEnablerRuleApplicationSession getProfileEntryEnablerRuleApplicationSession(Proxy proxy)
                                                                                       throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

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,
                                                                                               Proxy proxy)
                                                                                                 throws NotFoundException,
                                                                                                        OperationFailedException

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

Parameters:

profileId - the Id of the Profile

proxy - a proxy

Returns:

a ProfileEntryEnableryRuleApplicationSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy 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.