org.osid.profile

Interface ProfileProxyManager

All Superinterfaces:

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

public interface ProfileProxyManager
extends OsidProxyManager, ProfileProfile

The profile manager provides access to profile sessions and provides interoperability tests for various aspects of this service. Method sin this manager accept a Proxy for passing information from server environments. 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 Summary

Methods

Modifier and Type	Method and Description
ProfileAdminSession	getProfileAdminSession(Proxy proxy) Gets the OsidSession associated with the profile administration service.
ProfileBatchProxyManager	getProfileBatchProxyManager() Gets a ProfileBatchProxyManager.
ProfileEntryAdminSession	getProfileEntryAdminSession(Proxy proxy) Gets the OsidSession associated with the profile entry administration service.
ProfileEntryAdminSession	getProfileEntryAdminSessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the profile entry admin service for the given profile.
ProfileEntryLookupSession	getProfileEntryLookupSession(Proxy proxy) Gets the OsidSession associated with the profile entry lookup service.
ProfileEntryLookupSession	getProfileEntryLookupSessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the profile entry lookup service for the given profile.
ProfileEntryNotificationSession	getProfileEntryNotificationSession(ProfileEntryReceiver profileEntryReceiver, Proxy proxy) Gets the notification session for notifications pertaining to profile entry changes.
ProfileEntryNotificationSession	getProfileEntryNotificationSessionForProfile(ProfileEntryReceiver profileEntryReceiver, Id profileId, Proxy proxy) Gets the OsidSession associated with the profile entry notification service for the given profile.
ProfileEntryProfileAssignmentSession	getProfileEntryProfileAssignmentSession(Proxy proxy) Gets the session for assigning profile entry to profile mappings.
ProfileEntryProfileSession	getProfileEntryProfileSession(Proxy proxy) Gets the session for retrieving profile entry to profile mappings.
ProfileEntryQuerySession	getProfileEntryQuerySession(Proxy proxy) Gets the OsidSession associated with the profile entry query service.
ProfileEntryQuerySession	getProfileEntryQuerySessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the profile entry query service for the given profile.
ProfileEntrySearchSession	getProfileEntrySearchSession(Proxy proxy) Gets the OsidSession associated with the profile entry search service.
ProfileEntrySearchSession	getProfileEntrySearchSessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the profile entry search service for the given profile.
ProfileEntrySmartProfileSession	getProfileEntrySmartProfileSession(Id profileId, Proxy proxy) Gets the session for managing dynamic profile entry profile.
ProfileHierarchyDesignSession	getProfileHierarchyDesignSession(Proxy proxy) Gets the session designing profile hierarchies.
ProfileHierarchySession	getProfileHierarchySession(Proxy proxy) Gets the session traversing profile hierarchies.
ProfileItemAdminSession	getProfileItemAdminSession(Proxy proxy) Gets the OsidSession associated with the profile item administration service.
ProfileItemAdminSession	getProfileItemAdminSessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the profile item admin service for the given profile.
ProfileItemLookupSession	getProfileItemLookupSession(Proxy proxy) Gets the OsidSession associated with the profile item lookup service.
ProfileItemLookupSession	getProfileItemLookupSessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the profile item lookup service for the given profile.
ProfileItemNotificationSession	getProfileItemNotificationSession(ProfileItemReceiver profileItemReceiver, Proxy proxy) Gets the notification session for notifications pertaining to profile item changes.
ProfileItemNotificationSession	getProfileItemNotificationSessionForProfile(ProfileItemReceiver profileItemReceiver, Id profileId, Proxy proxy) Gets the OsidSession associated with the profile item notification service for the given profile.
ProfileItemProfileSession	getProfileItemProfileAssignmentSession(Proxy proxy) Gets the session for assigning profile item to profile mappings.
ProfileItemProfileSession	getProfileItemProfileSession(Proxy proxy) Gets the session for retrieving profile item to profile mappings.
ProfileItemQuerySession	getProfileItemQuerySession(Proxy proxy) Gets a profile item query session.
ProfileItemQuerySession	getProfileItemQuerySessionForProfile(Id profileId, Proxy proxy) Gets a profile item query session for the given profile.
ProfileItemSearchSession	getProfileItemSearchSession(Proxy proxy) Gets the OsidSession associated with the profile item search service.
ProfileItemSearchSession	getProfileItemSearchSessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the profile item search service for the given profile.
ProfileItemSmartProfileSession	getProfileItemSmartProfileSession(Id profileId, Proxy proxy) Gets the session for managing dynamic profile item profile.
ProfileLookupSession	getProfileLookupSession(Proxy proxy) Gets the OsidSession associated with the profile lookup service.
ProfileNotificationSession	getProfileNotificationSession(ProfileReceiver profileReceiver, Proxy proxy) Gets the notification session for notifications pertaining to profile service changes.
ProfileQuerySession	getProfileQuerySession(Proxy proxy) Gets the profile query session.
ProfileRulesProxyManager	getProfileRulesProxyManager() Gets a ProfileRulesProxyManager.
ProfileSearchSession	getProfileSearchSession(Proxy proxy) Gets the OsidSession associated with the profile search service.
ProfilingSession	getProfilingSession(Proxy proxy) Gets a ProfilingSession which is responsible for performing profile checks.
ProfilingSession	getProfilingSessionForProfile(Id profileId, Proxy proxy) Gets a ProfilingSession which is responsible for performing profile checks for the given profile.

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.ProfileProfile

getProfileEntryConditionRecordTypes, getProfileEntryRecordTypes, getProfileEntrySearchRecordTypes, getProfileItemRecordTypes, getProfileItemSearchRecordTypes, getProfileRecordTypes, getProfileSearchRecordTypes, supportsProfileAdmin, supportsProfileBatch, supportsProfileEntryAdmin, supportsProfileEntryConditionRecordType, supportsProfileEntryLookup, supportsProfileEntryNotification, supportsProfileEntryProfile, supportsProfileEntryProfileAssignment, supportsProfileEntryQuery, supportsProfileEntryRecordType, supportsProfileEntryRelationshpSmartProfile, supportsProfileEntrySearch, supportsProfileEntrySearchRecordType, supportsProfileHierarchy, supportsProfileHierarchyDesign, supportsProfileItemAdmin, supportsProfileItemLookup, supportsProfileItemNotification, supportsProfileItemProfile, supportsProfileItemProfileAssignment, supportsProfileItemQuery, supportsProfileItemRecordType, supportsProfileItemSearch, supportsProfileItemSearchRecordType, supportsProfileItemSmartProfile, supportsProfileLookup, supportsProfileNotification, supportsProfileQuery, supportsProfileRecordType, supportsProfileRules, supportsProfileSearch, supportsProfileSearchRecordType, supportsProfiling, 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

getProfilingSession

ProfilingSession getProfilingSession(Proxy proxy)
                                     throws OperationFailedException

Gets a ProfilingSession which is responsible for performing profile checks.

Parameters:

proxy - a proxy

Returns:

a profiling session for this service

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfiling() is false

Compliance:

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

getProfilingSessionForProfile

ProfilingSession getProfilingSessionForProfile(Id profileId,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets a ProfilingSession which is responsible for performing profile checks for the given profile.

Parameters:

profileId - the Id of the profile

proxy - a proxy

Returns:

a ProfilingSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfiling() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryLookupSession

ProfileEntryLookupSession getProfileEntryLookupSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the profile entry lookup service.

Parameters:

proxy - a proxy

Returns:

a ProfileEntryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryLookup() is false

Compliance:

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

getProfileEntryLookupSessionForProfile

ProfileEntryLookupSession getProfileEntryLookupSessionForProfile(Id profileId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

profileId - the Id of the profile

proxy - a proxy

Returns:

a ProfileEntryLookupSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryQuerySession

ProfileEntryQuerySession getProfileEntryQuerySession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the profile entry query service.

Parameters:

proxy - a proxy

Returns:

a ProfileEntryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryQuery() is false

Compliance:

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

getProfileEntryQuerySessionForProfile

ProfileEntryQuerySession getProfileEntryQuerySessionForProfile(Id profileId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

profileId - the Id of the Profile

proxy - a proxy

Returns:

a ProfileEntryQuerySession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryQuery() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntrySearchSession

ProfileEntrySearchSession getProfileEntrySearchSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the profile entry search service.

Parameters:

proxy - a proxy

Returns:

a ProfileEntrySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntrySearch() is false

Compliance:

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

getProfileEntrySearchSessionForProfile

ProfileEntrySearchSession getProfileEntrySearchSessionForProfile(Id profileId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the profile entry search service for the given profile.

Parameters:

profileId - the Id of the profile

proxy - a proxy

Returns:

a ProfileEntrySearchSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryAdminSession

ProfileEntryAdminSession getProfileEntryAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the profile entry administration service.

Parameters:

proxy - a proxy

Returns:

a ProfileEntryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryAdmin() is false

Compliance:

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

getProfileEntryAdminSessionForProfile

ProfileEntryAdminSession getProfileEntryAdminSessionForProfile(Id profileId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the profile entry admin service for the given profile.

Parameters:

profileId - the Id of the profile

proxy - a proxy

Returns:

a ProfileEntryAdminSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryNotificationSession

ProfileEntryNotificationSession getProfileEntryNotificationSession(ProfileEntryReceiver profileEntryReceiver,
                                                                 Proxy proxy)
                                                                   throws OperationFailedException

Gets the notification session for notifications pertaining to profile entry changes.

Parameters:

profileEntryReceiver - the profile entry receiver

proxy - a proxy

Returns:

a ProfileEntryNotificationSession

Throws:

NullArgumentException - profileEntryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryNotification() is false

Compliance:

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

getProfileEntryNotificationSessionForProfile

ProfileEntryNotificationSession getProfileEntryNotificationSessionForProfile(ProfileEntryReceiver profileEntryReceiver,
                                                                           Id profileId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

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

Parameters:

profileEntryReceiver - the profile entry receiver interface

profileId - the profile entry receiver

proxy - a proxy

Returns:

a ProfileEntryNotificationSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileEntryReceiver, profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryProfileSession

ProfileEntryProfileSession getProfileEntryProfileSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the session for retrieving profile entry to profile mappings.

Parameters:

proxy - a proxy

Returns:

a ProfileEntryProfileSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryProfile() is false

Compliance:

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

getProfileEntryProfileAssignmentSession

ProfileEntryProfileAssignmentSession getProfileEntryProfileAssignmentSession(Proxy proxy)
                                                                             throws OperationFailedException

Gets the session for assigning profile entry to profile mappings.

Parameters:

proxy - a proxy

Returns:

a ProfileEntryProfileAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryProfileAssignment() is false

Compliance:

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

getProfileEntrySmartProfileSession

ProfileEntrySmartProfileSession getProfileEntrySmartProfileSession(Id profileId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the session for managing dynamic profile entry profile.

Parameters:

profileId - the Id of the profile

proxy - a proxy

Returns:

a ProfileEntrySmartProfileSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntrySmartProfile() is false

Compliance:

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

getProfileItemLookupSession

ProfileItemLookupSession getProfileItemLookupSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the profile item lookup service.

Parameters:

proxy - a proxy

Returns:

a ProfileItemLookupSession

Throws:

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemLookup() is false

Compliance:

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

getProfileItemLookupSessionForProfile

ProfileItemLookupSession getProfileItemLookupSessionForProfile(Id profileId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the profile item lookup service for the given profile.

Parameters:

profileId - the Id of the profile

proxy - a proxy

Returns:

a ProfileItemLookupSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemLookup() or supportsVisibleFederation() is false

Compliance:

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

getProfileItemQuerySession

ProfileItemQuerySession getProfileItemQuerySession(Proxy proxy)
                                                   throws OperationFailedException

Gets a profile item query session.

Parameters:

proxy - a proxy

Returns:

a ProfileItemQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemQuery() is false

Compliance:

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

getProfileItemQuerySessionForProfile

ProfileItemQuerySession getProfileItemQuerySessionForProfile(Id profileId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets a profile item query session for the given profile.

Parameters:

profileId - the Id of the profile

proxy - a proxy

Returns:

a ProfileItemQuerySession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemQuery() or supportsVisibleFederation() is false

Compliance:

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

getProfileItemSearchSession

ProfileItemSearchSession getProfileItemSearchSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the profile item search service.

Parameters:

proxy - a proxy

Returns:

a ProfileItemSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemSearch() is false

Compliance:

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

getProfileItemSearchSessionForProfile

ProfileItemSearchSession getProfileItemSearchSessionForProfile(Id profileId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the profile item search service for the given profile.

Parameters:

profileId - the Id of the profile

proxy - a proxy

Returns:

a ProfileItemSearchSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemSearch() or supportsVisibleFederation() is false

Compliance:

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

getProfileItemAdminSession

ProfileItemAdminSession getProfileItemAdminSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the profile item administration service.

Parameters:

proxy - a proxy

Returns:

a ProfileItemAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemAdmin() is false

Compliance:

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

getProfileItemAdminSessionForProfile

ProfileItemAdminSession getProfileItemAdminSessionForProfile(Id profileId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the profile item admin service for the given profile.

Parameters:

profileId - the Id of the profile

proxy - a proxy

Returns:

a ProfileItemAdminSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProfileItemNotificationSession

ProfileItemNotificationSession getProfileItemNotificationSession(ProfileItemReceiver profileItemReceiver,
                                                               Proxy proxy)
                                                                 throws OperationFailedException

Gets the notification session for notifications pertaining to profile item changes.

Parameters:

profileItemReceiver - the profile item receiver

proxy - a proxy

Returns:

a ProfileItemNotificationSession

Throws:

NullArgumentException - profileItemReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemNotification() is false

Compliance:

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

getProfileItemNotificationSessionForProfile

ProfileItemNotificationSession getProfileItemNotificationSessionForProfile(ProfileItemReceiver profileItemReceiver,
                                                                         Id profileId,
                                                                         Proxy proxy)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

Gets the OsidSession associated with the profile item notification service for the given profile.

Parameters:

profileItemReceiver - the profile item receiver

profileId - the Id of the profile

proxy - a proxy

Returns:

a ProfileItemNotificationSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileItemReceiver, profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemNotification() or supportsVisibleFederation() is false

Compliance:

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

getProfileItemProfileSession

ProfileItemProfileSession getProfileItemProfileSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the session for retrieving profile item to profile mappings.

Parameters:

proxy - a proxy

Returns:

a ProfileItemProfileSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemProfile() is false

Compliance:

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

getProfileItemProfileAssignmentSession

ProfileItemProfileSession getProfileItemProfileAssignmentSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the session for assigning profile item to profile mappings.

Parameters:

proxy - a proxy

Returns:

a ProfileItemProfileAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemProfileAssignment() is false

Compliance:

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

getProfileItemSmartProfileSession

ProfileItemSmartProfileSession getProfileItemSmartProfileSession(Id profileId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the session for managing dynamic profile item profile.

Parameters:

profileId - the Id of the profile

proxy - a proxy

Returns:

a ProfileItemSmartProfileSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemSmartProfile() is false

Compliance:

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

getProfileLookupSession

ProfileLookupSession getProfileLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the profile lookup service.

Parameters:

proxy - a proxy

Returns:

a ProfileLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileLookup() is false

Compliance:

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

getProfileQuerySession

ProfileQuerySession getProfileQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the profile query session.

Parameters:

proxy - a proxy

Returns:

a ProfileQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileQuery() is false

Compliance:

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

getProfileSearchSession

ProfileSearchSession getProfileSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the profile search service.

Parameters:

proxy - a proxy

Returns:

a ProfileSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileSearch() is false

Compliance:

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

getProfileAdminSession

ProfileAdminSession getProfileAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the profile administration service.

Parameters:

proxy - a proxy

Returns:

a ProfileAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileAdmin() is false

Compliance:

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

getProfileNotificationSession

ProfileNotificationSession getProfileNotificationSession(ProfileReceiver profileReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the notification session for notifications pertaining to profile service changes.

Parameters:

profileReceiver - the profile receiver

proxy - a proxy

Returns:

a ProfileNotificationSession

Throws:

NullArgumentException - profileReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileNotification() is false

Compliance:

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

getProfileHierarchySession

ProfileHierarchySession getProfileHierarchySession(Proxy proxy)
                                                   throws OperationFailedException

Gets the session traversing profile hierarchies.

Parameters:

proxy - a proxy

Returns:

a ProfileHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileHierarchy() is false

Compliance:

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

getProfileHierarchyDesignSession

ProfileHierarchyDesignSession getProfileHierarchyDesignSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the session designing profile hierarchies.

Parameters:

proxy - a proxy

Returns:

a ProfileHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileHierarchyDesign() is false

Compliance:

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

getProfileBatchProxyManager

ProfileBatchProxyManager getProfileBatchProxyManager()
                                                     throws OperationFailedException

Gets a ProfileBatchProxyManager.

Returns:

a ProfileBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileBatch() is false

Compliance:

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

getProfileRulesProxyManager

ProfileRulesProxyManager getProfileRulesProxyManager()
                                                     throws OperationFailedException

Gets a ProfileRulesProxyManager.

Returns:

a ProfileRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileRules() is false

Compliance:

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