OSID Logo
OSID Specifications
profile package
Version 3.0.0
Interfaceosid.profile.ProfileProxyManager
Implementsosid.OsidProxyManager
osid.profile.ProfileProfile
Used Byosid.orchestration.OrchestrationManager
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 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
MethodgetProfilingSession
Description

Gets a ProfilingSession which is responsible for performing profile checks.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfilingSessiona profiling session for this service
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfiling() is false
ComplianceoptionalThis method must be implemented if supportsProfiling() is true .
MethodgetProfilingSessionForProfile
Description

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

Parametersosid.id.IdprofileIdthe Id of the profile
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfilingSessiona ProfilingSession
ErrorsNOT_FOUNDprofileId not found
NULL_ARGUMENTprofileId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfiling() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfiling() and supportsVisibleFederation() are true .
MethodgetProfileEntryLookupSession
Description

Gets the OsidSession associated with the profile entry lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileEntryLookupSessiona ProfileEntryLookupSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileEntryLookup() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryLookup() is true .
MethodgetProfileEntryLookupSessionForProfile
Description

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

Parametersosid.id.IdprofileIdthe Id of the profile
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileEntryLookupSessiona ProfileEntryLookupSession
ErrorsNOT_FOUNDprofileId not found
NULL_ARGUMENTprofileId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileEntryLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryLookup() and supportsVisibleFederation() are true .
MethodgetProfileEntryQuerySession
Description

Gets the OsidSession associated with the profile entry query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileEntryQuerySessiona ProfileEntryQuerySession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileEntryQuery() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryQuery() is true .
MethodgetProfileEntryQuerySessionForProfile
Description

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

Parametersosid.id.IdprofileIdthe Id of the Profile
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileEntryQuerySessiona ProfileEntryQuerySession
ErrorsNOT_FOUNDno Profile found by the given Id
NULL_ARGUMENTprofileId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileEntryQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryQuery() and supportsVisibleFederation() are true
MethodgetProfileEntrySearchSession
Description

Gets the OsidSession associated with the profile entry search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileEntrySearchSessiona ProfileEntrySearchSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileEntrySearch() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntrySearch() is true .
MethodgetProfileEntrySearchSessionForProfile
Description

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

Parametersosid.id.IdprofileIdthe Id of the profile
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileEntrySearchSessiona ProfileEntrySearchSession
ErrorsNOT_FOUNDprofileId not found
NULL_ARGUMENTprofileId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileEntrySearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntrySearch() and supportsVisibleFederation() are true .
MethodgetProfileEntryAdminSession
Description

Gets the OsidSession associated with the profile entry administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileEntryAdminSessiona ProfileEntryAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileEntryAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryAdmin() is true .
MethodgetProfileEntryAdminSessionForProfile
Description

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

Parametersosid.id.IdprofileIdthe Id of the profile
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileEntryAdminSessiona ProfileEntryAdminSession
ErrorsNOT_FOUNDprofileId not found
NULL_ARGUMENTprofileId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileEntryAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryAdmin() and supportsVisibleFederation() are true .
MethodgetProfileEntryNotificationSession
Description

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

Parametersosid.profile.ProfileEntryReceiverprofileEntryReceiverthe profile entry receiver
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileEntryNotificationSessiona ProfileEntryNotificationSession
ErrorsNULL_ARGUMENTprofileEntryReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileEntryNotification() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryNotification() is true .
MethodgetProfileEntryNotificationSessionForProfile
Description

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

Parametersosid.profile.ProfileEntryReceiverprofileEntryReceiverthe profile entry receiver interface
osid.id.IdprofileIdthe profile entry receiver
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileEntryNotificationSessiona ProfileEntryNotificationSession
ErrorsNOT_FOUNDprofileId not found
NULL_ARGUMENTprofileEntryReceiver, profileId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileEntryNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryNotification() and supportsVisibleFederation() are true .
MethodgetProfileEntryProfileSession
Description

Gets the session for retrieving profile entry to profile mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileEntryProfileSessiona ProfileEntryProfileSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileEntryProfile() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryProfile() is true .
MethodgetProfileEntryProfileAssignmentSession
Description

Gets the session for assigning profile entry to profile mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileEntryProfileAssignmentSessiona ProfileEntryProfileAssignmentSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileEntryProfileAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryProfileAssignment() is true .
MethodgetProfileEntrySmartProfileSession
Description

Gets the session for managing dynamic profile entry profile.

Parametersosid.id.IdprofileIdthe Id of the profile
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileEntrySmartProfileSessiona ProfileEntrySmartProfileSession
ErrorsNOT_FOUNDprofileId not found
NULL_ARGUMENTprofileId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileEntrySmartProfile() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntrySmartProfile() is true .
MethodgetProfileItemLookupSession
Description

Gets the OsidSession associated with the profile item lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileItemLookupSessiona ProfileItemLookupSession
ErrorsNULL_ARGUMENTprofileId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileItemLookup() is false
ComplianceoptionalThis method must be implemented if supportsProfileItemLookup() is true .
MethodgetProfileItemLookupSessionForProfile
Description

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

Parametersosid.id.IdprofileIdthe Id of the profile
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileItemLookupSessiona ProfileItemLookupSession
ErrorsNOT_FOUNDprofileId not found
NULL_ARGUMENTprofileId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileItemLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileItemLookup() and supportsVisibleFederation() are true .
MethodgetProfileItemQuerySession
Description

Gets a profile item query session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileItemQuerySessiona ProfileItemQuerySession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileItemQuery() is false
ComplianceoptionalThis method must be implemented if supportsProfileItemQuery() is true .
MethodgetProfileItemQuerySessionForProfile
Description

Gets a profile item query session for the given profile.

Parametersosid.id.IdprofileIdthe Id of the profile
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileItemQuerySessiona ProfileItemQuerySession
ErrorsNOT_FOUNDprofileId not found
NULL_ARGUMENTprofileId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileItemQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileItemQuery() and supportsVisibleFederation() are true .
MethodgetProfileItemSearchSession
Description

Gets the OsidSession associated with the profile item search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileItemSearchSessiona ProfileItemSearchSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileItemSearch() is false
ComplianceoptionalThis method must be implemented if supportsProfileItemSearch() is true .
MethodgetProfileItemSearchSessionForProfile
Description

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

Parametersosid.id.IdprofileIdthe Id of the profile
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileItemSearchSessiona ProfileItemSearchSession
ErrorsNOT_FOUNDprofileId not found
NULL_ARGUMENTprofileId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileItemSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileItemSearch() and supportsVisibleFederation() are true .
MethodgetProfileItemAdminSession
Description

Gets the OsidSession associated with the profile item administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileItemAdminSessiona ProfileItemAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileItemAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProfileItemAdmin() is true .
MethodgetProfileItemAdminSessionForProfile
Description

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

Parametersosid.id.IdprofileIdthe Id of the profile
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileItemAdminSessiona ProfileItemAdminSession
ErrorsNOT_FOUNDprofileId not found
NULL_ARGUMENTprofileId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileItemAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileItemAdmin() and supportsVisibleFederation() are true .
MethodgetProfileItemNotificationSession
Description

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

Parametersosid.profile.ProfileItemReceiverprofileItemReceiverthe profile item receiver
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileItemNotificationSessiona ProfileItemNotificationSession
ErrorsNULL_ARGUMENTprofileItemReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileItemNotification() is false
ComplianceoptionalThis method must be implemented if supportsProfileItemNotification() is true .
MethodgetProfileItemNotificationSessionForProfile
Description

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

Parametersosid.profile.ProfileItemReceiverprofileItemReceiverthe profile item receiver
osid.id.IdprofileIdthe Id of the profile
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileItemNotificationSessiona ProfileItemNotificationSession
ErrorsNOT_FOUNDprofileId not found
NULL_ARGUMENTprofileItemReceiver, profileId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileItemNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProfileItemNotification() and supportsVisibleFederation() are true .
MethodgetProfileItemProfileSession
Description

Gets the session for retrieving profile item to profile mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileItemProfileSessiona ProfileItemProfileSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileItemProfile() is false
ComplianceoptionalThis method must be implemented if supportsProfileItemProfile() is true .
MethodgetProfileItemProfileAssignmentSession
Description

Gets the session for assigning profile item to profile mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileItemProfileSessiona ProfileItemProfileAssignmentSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileItemProfileAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProfileItemProfileAssignment() is true .
MethodgetProfileItemSmartProfileSession
Description

Gets the session for managing dynamic profile item profile.

Parametersosid.id.IdprofileIdthe Id of the profile
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileItemSmartProfileSessiona ProfileItemSmartProfileSession
ErrorsNOT_FOUNDprofileId not found
NULL_ARGUMENTprofileId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileItemSmartProfile() is false
ComplianceoptionalThis method must be implemented if supportsProfileItemSmartProfile() is true .
MethodgetProfileLookupSession
Description

Gets the OsidSession associated with the profile lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileLookupSessiona ProfileLookupSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileLookup() is false
ComplianceoptionalThis method must be implemented if supportsProfileLookup() is true.
MethodgetProfileQuerySession
Description

Gets the profile query session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileQuerySessiona ProfileQuerySession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileQuery() is false
ComplianceoptionalThis method must be implemented if supportsProfileQuery() is true .
MethodgetProfileSearchSession
Description

Gets the OsidSession associated with the profile search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileSearchSessiona ProfileSearchSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileSearch() is false
ComplianceoptionalThis method must be implemented if supportsProfileSearch() is true.
MethodgetProfileAdminSession
Description

Gets the OsidSession associated with the profile administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileAdminSessiona ProfileAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProfileAdmin() is true.
MethodgetProfileNotificationSession
Description

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

Parametersosid.profile.ProfileReceiverprofileReceiverthe profile receiver
osid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileNotificationSessiona ProfileNotificationSession
ErrorsNULL_ARGUMENTprofileReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileNotification() is false
ComplianceoptionalThis method must be implemented if supportsProfileNotification() is true.
MethodgetProfileHierarchySession
Description

Gets the session traversing profile hierarchies.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileHierarchySessiona ProfileHierarchySession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsProfileHierarchy() is true.
MethodgetProfileHierarchyDesignSession
Description

Gets the session designing profile hierarchies.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.profile.ProfileHierarchyDesignSessiona ProfileHierarchyDesignSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsProfileHierarchyDesign() is true.
MethodgetProfileBatchProxyManager
Description

Gets a ProfileBatchProxyManager .

Returnosid.profile.batch.ProfileBatchProxyManagera ProfileBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileBatch() is false
ComplianceoptionalThis method must be implemented if supportsProfileBatch() is true.
MethodgetProfileRulesProxyManager
Description

Gets a ProfileRulesProxyManager .

Returnosid.profile.rules.ProfileRulesProxyManagera ProfileRulesProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProfileRules() is false
ComplianceoptionalThis method must be implemented if supportsProfileRules() is true.