Interface | osid.profile.ProfileProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.profile.ProfileProfile | |||
Description |
The profile manager provides access to profile sessions and
provides interoperability tests for various aspects of this
service. Method sin this manager accept a
| ||
Method | getProfilingSession | ||
Description |
Gets a | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfilingSession | a profiling session for this service | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfiling() is false | ||
Compliance | optional | This method must be implemented if supportsProfiling() is
true. | |
Method | getProfilingSessionForProfile | ||
Description |
Gets a | ||
Parameters | osid.id.Id | profileId | the Id of the profile |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfilingSession | a ProfilingSession | |
Errors | NOT_FOUND | profileId not found | |
NULL_ARGUMENT | profileId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfiling() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsProfiling() and
supportsVisibleFederation() are true. | |
Method | getProfileEntryLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileEntryLookupSession | a ProfileEntryLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryLookup() is false | ||
Compliance | optional | This method must be implemented if supportsProfileEntryLookup()
is true. | |
Method | getProfileEntryLookupSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the profile |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileEntryLookupSession | a ProfileEntryLookupSession | |
Errors | NOT_FOUND | profileId not found | |
NULL_ARGUMENT | profileId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProfileEntryLookup()
and supportsVisibleFederation() are true.
| |
Method | getProfileEntryQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileEntryQuerySession | a ProfileEntryQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryQuery() is false | ||
Compliance | optional | This method must be implemented if supportsProfileEntryQuery()
is true. | |
Method | getProfileEntryQuerySessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileEntryQuerySession | a ProfileEntryQuerySession | |
Errors | NOT_FOUND | no Profile found by the given Id | |
NULL_ARGUMENT | profileId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProfileEntryQuery()
and supportsVisibleFederation() are true | |
Method | getProfileEntrySearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileEntrySearchSession | a ProfileEntrySearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntrySearch() is false | ||
Compliance | optional | This method must be implemented if supportsProfileEntrySearch()
is true. | |
Method | getProfileEntrySearchSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the profile |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileEntrySearchSession | a ProfileEntrySearchSession | |
Errors | NOT_FOUND | profileId not found | |
NULL_ARGUMENT | profileId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntrySearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProfileEntrySearch()
and supportsVisibleFederation() are true.
| |
Method | getProfileEntryAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileEntryAdminSession | a ProfileEntryAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProfileEntryAdmin()
is true. | |
Method | getProfileEntryAdminSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the profile |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileEntryAdminSession | a ProfileEntryAdminSession | |
Errors | NOT_FOUND | profileId not found | |
NULL_ARGUMENT | profileId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProfileEntryAdmin()
and supportsVisibleFederation() are true.
| |
Method | getProfileEntryNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to profile entry changes. | ||
Parameters | osid.profile.ProfileEntryReceiver | profileEntryReceiver | the profile entry receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileEntryNotificationSession | a ProfileEntryNotificationSession | |
Errors | NULL_ARGUMENT | profileEntryReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryNotification() is true. | |
Method | getProfileEntryNotificationSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.profile.ProfileEntryReceiver | profileEntryReceiver | the profile entry receiver interface |
osid.id.Id | profileId | the profile entry receiver | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileEntryNotificationSession | a ProfileEntryNotificationSession | |
Errors | NOT_FOUND | profileId not found | |
NULL_ARGUMENT | profileEntryReceiver, profileId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryNotification() and
supportsVisibleFederation() are true. | |
Method | getProfileEntryProfileSession | ||
Description |
Gets the session for retrieving profile entry to profile mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileEntryProfileSession | a ProfileEntryProfileSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryProfile() is false | ||
Compliance | optional | This method must be implemented if supportsProfileEntryProfile()
is true. | |
Method | getProfileEntryProfileAssignmentSession | ||
Description |
Gets the session for assigning profile entry to profile mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileEntryProfileAssignmentSession | a ProfileEntryProfileAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryProfileAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsProfileEntryProfileAssignment() is true. | |
Method | getProfileEntrySmartProfileSession | ||
Description |
Gets the session for managing dynamic profile entry profile. | ||
Parameters | osid.id.Id | profileId | the Id of the profile |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileEntrySmartProfileSession | a ProfileEntrySmartProfileSession | |
Errors | NOT_FOUND | profileId not found | |
NULL_ARGUMENT | profileId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntrySmartProfile() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntrySmartProfile() is true. | |
Method | getProfileItemLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileItemLookupSession | a ProfileItemLookupSession | |
Errors | NULL_ARGUMENT | profileId is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileItemLookup() is false | ||
Compliance | optional | This method must be implemented if supportsProfileItemLookup()
is true. | |
Method | getProfileItemLookupSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the profile |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileItemLookupSession | a ProfileItemLookupSession | |
Errors | NOT_FOUND | profileId not found | |
NULL_ARGUMENT | profileId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileItemLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProfileItemLookup()
and supportsVisibleFederation() are true.
| |
Method | getProfileItemQuerySession | ||
Description |
Gets a profile item query session. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileItemQuerySession | a ProfileItemQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileItemQuery() is false | ||
Compliance | optional | This method must be implemented if supportsProfileItemQuery()
is true. | |
Method | getProfileItemQuerySessionForProfile | ||
Description |
Gets a profile item query session for the given profile. | ||
Parameters | osid.id.Id | profileId | the Id of the profile |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileItemQuerySession | a ProfileItemQuerySession | |
Errors | NOT_FOUND | profileId not found | |
NULL_ARGUMENT | profileId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileItemQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProfileItemQuery()
and supportsVisibleFederation() are true.
| |
Method | getProfileItemSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileItemSearchSession | a ProfileItemSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileItemSearch() is false | ||
Compliance | optional | This method must be implemented if supportsProfileItemSearch()
is true. | |
Method | getProfileItemSearchSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the profile |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileItemSearchSession | a ProfileItemSearchSession | |
Errors | NOT_FOUND | profileId not found | |
NULL_ARGUMENT | profileId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileItemSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProfileItemSearch()
and supportsVisibleFederation() are true.
| |
Method | getProfileItemAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileItemAdminSession | a ProfileItemAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileItemAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProfileItemAdmin()
is true. | |
Method | getProfileItemAdminSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the profile |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileItemAdminSession | a ProfileItemAdminSession | |
Errors | NOT_FOUND | profileId not found | |
NULL_ARGUMENT | profileId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileItemAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProfileItemAdmin()
and supportsVisibleFederation() are true.
| |
Method | getProfileItemNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to profile item changes. | ||
Parameters | osid.profile.ProfileItemReceiver | profileItemReceiver | the profile item receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileItemNotificationSession | a ProfileItemNotificationSession | |
Errors | NULL_ARGUMENT | profileItemReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileItemNotification() is false | ||
Compliance | optional | This method must be implemented if supportsProfileItemNotification()
is true. | |
Method | getProfileItemNotificationSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.profile.ProfileItemReceiver | profileItemReceiver | the profile item receiver |
osid.id.Id | profileId | the Id of the profile | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileItemNotificationSession | a ProfileItemNotificationSession | |
Errors | NOT_FOUND | profileId not found | |
NULL_ARGUMENT | profileItemReceiver, profileId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileItemNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProfileItemNotification()
and supportsVisibleFederation() are true.
| |
Method | getProfileItemProfileSession | ||
Description |
Gets the session for retrieving profile item to profile mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileItemProfileSession | a ProfileItemProfileSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileItemProfile() is false | ||
Compliance | optional | This method must be implemented if supportsProfileItemProfile()
is true. | |
Method | getProfileItemProfileAssignmentSession | ||
Description |
Gets the session for assigning profile item to profile mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileItemProfileSession | a ProfileItemProfileAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileItemProfileAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsProfileItemProfileAssignment() is true. | |
Method | getProfileItemSmartProfileSession | ||
Description |
Gets the session for managing dynamic profile item profile. | ||
Parameters | osid.id.Id | profileId | the Id of the profile |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileItemSmartProfileSession | a ProfileItemSmartProfileSession | |
Errors | NOT_FOUND | profileId not found | |
NULL_ARGUMENT | profileId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileItemSmartProfile() is false | ||
Compliance | optional | This method must be implemented if supportsProfileItemSmartProfile()
is true. | |
Method | getProfileLookupSession | ||
Description |
Gets the OsidSession associated with the profile lookup service. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileLookupSession | a ProfileLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileLookup() is false | ||
Compliance | optional | This method must be implemented if supportsProfileLookup()
is true. | |
Method | getProfileQuerySession | ||
Description |
Gets the profile query session. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileQuerySession | a ProfileQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileQuery() is false | ||
Compliance | optional | This method must be implemented if supportsProfileQuery() is
true. | |
Method | getProfileSearchSession | ||
Description |
Gets the OsidSession associated with the profile search service. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileSearchSession | a ProfileSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileSearch() is false | ||
Compliance | optional | This method must be implemented if supportsProfileSearch()
is true. | |
Method | getProfileAdminSession | ||
Description |
Gets the OsidSession associated with the profile administration service. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileAdminSession | a ProfileAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProfileAdmin() is
true. | |
Method | getProfileNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to profile service changes. | ||
Parameters | osid.profile.ProfileReceiver | profileReceiver | the profile receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.profile.ProfileNotificationSession | a ProfileNotificationSession | |
Errors | NULL_ARGUMENT | profileReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileNotification() is false | ||
Compliance | optional | This method must be implemented if supportsProfileNotification()
is true. | |
Method | getProfileHierarchySession | ||
Description |
Gets the session traversing profile hierarchies. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileHierarchySession | a ProfileHierarchySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsProfileHierarchy()
is true. | |
Method | getProfileHierarchyDesignSession | ||
Description |
Gets the session designing profile hierarchies. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.profile.ProfileHierarchyDesignSession | a ProfileHierarchyDesignSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsProfileHierarchyDesign()
is true. | |
Method | getProfileBatchProxyManager | ||
Description |
Gets a | ||
Return | osid.profile.batch.ProfileBatchProxyManager | a ProfileBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProfileBatch() is false | ||
Compliance | optional | This method must be implemented if supportsProfileBatch() is
true. | |
Method | getProfileRulesProxyManager | ||
Description |
Gets a | ||
Return | osid.profile.rules.ProfileRulesProxyManager | a ProfileRulesProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProfileRules() is false | ||
Compliance | optional | This method must be implemented if supportsProfileRules() is
true. |