public interface ProfileManager extends OsidManager, ProfileProfile
The profile manager provides access to profile sessions and provides interoperability tests for various aspects of this service. 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 Modifier and Type | Method and Description |
---|---|
ProfileAdminSession |
getProfileAdminSession()
Gets the OsidSession associated with the profile administration
service.
|
ProfileBatchManager |
getProfileBatchManager()
Gets a
ProfileBatchManager. |
ProfileEntryAdminSession |
getProfileEntryAdminSession()
Gets the
OsidSession associated with the profile entry
administration service. |
ProfileEntryAdminSession |
getProfileEntryAdminSessionForProfile(Id profileId)
Gets the
OsidSession associated with the profile entry
admin service for the given profile. |
ProfileEntryLookupSession |
getProfileEntryLookupSession()
Gets the
OsidSession associated with the profile entry
lookup service. |
ProfileEntryLookupSession |
getProfileEntryLookupSessionForProfile(Id profileId)
Gets the
OsidSession associated with the profile entry
lookup service for the given profile. |
ProfileEntryNotificationSession |
getProfileEntryNotificationSession(ProfileEntryReceiver profileEntryReceiver)
Gets the notification session for notifications pertaining to profile
entry changes.
|
ProfileEntryNotificationSession |
getProfileEntryNotificationSessionForProfile(ProfileEntryReceiver profileEntryReceiver,
Id profileId)
Gets the
OsidSession associated with the profile entry
notification service for the given profile. |
ProfileEntryProfileAssignmentSession |
getProfileEntryProfileAssignmentSession()
Gets the session for assigning profile entries to profile mappings.
|
ProfileEntryProfileSession |
getProfileEntryProfileSession()
Gets the session for retrieving profile entry to profile mappings.
|
ProfileEntryQuerySession |
getProfileEntryQuerySession()
Gets the
OsidSession associated with the profile entry
query service. |
ProfileEntryQuerySession |
getProfileEntryQuerySessionForProfile(Id profileId)
Gets the
OsidSession associated with the profile entry
query service for the given profile. |
ProfileEntrySearchSession |
getProfileEntrySearchSession()
Gets the
OsidSession associated with the profile entry
search service. |
ProfileEntrySearchSession |
getProfileEntrySearchSessionForProfile(Id profileId)
Gets the
OsidSession associated with the profile entry
search service for the given profile. |
ProfileEntrySmartProfileSession |
getProfileEntrySmartProfileSession(Id profileId)
Gets the session for managing dynamic profile entry profiles.
|
ProfileHierarchyDesignSession |
getProfileHierarchyDesignSession()
Gets the session designing profile hierarchies.
|
ProfileHierarchySession |
getProfileHierarchySession()
Gets the session traversing profile hierarchies.
|
ProfileItemAdminSession |
getProfileItemAdminSession()
Gets the
OsidSession associated with the profile item
administration service. |
ProfileItemAdminSession |
getProfileItemAdminSessionForProfile(Id profileId)
Gets the
OsidSession associated with the profile item
admin service for the given profile. |
ProfileItemLookupSession |
getProfileItemLookupSession()
Gets the
OsidSession associated with the profile item
lookup service. |
ProfileItemLookupSession |
getProfileItemLookupSessionForProfile(Id profileId)
Gets the
OsidSession associated with the profile item
lookup service for the given profile. |
ProfileItemNotificationSession |
getProfileItemNotificationSession(ProfileItemReceiver profileItemReceiver)
Gets the notification session for notifications pertaining to profile
item changes.
|
ProfileItemNotificationSession |
getProfileItemNotificationSessionForProfile(ProfileItemReceiver profileItemReceiver,
Id profileId)
Gets the
OsidSession associated with the profile item
notification service for the given profile. |
ProfileItemProfileSession |
getProfileItemProfileAssignmentSession()
Gets the session for assigning profile item to profile mappings.
|
ProfileItemProfileSession |
getProfileItemProfileSession()
Gets the session for retrieving profile item to profile mappings.
|
ProfileItemQuerySession |
getProfileItemQuerySession()
Gets a profile item query session.
|
ProfileItemQuerySession |
getProfileItemQuerySessionForProfile(Id profileId)
Gets a profile item query session for the given profile.
|
ProfileItemSearchSession |
getProfileItemSearchSession()
Gets the
OsidSession associated with the profile item
search service. |
ProfileItemSearchSession |
getProfileItemSearchSessionForProfile(Id profileId)
Gets the
OsidSession associated with the profile item
search service for the given profile. |
ProfileItemSmartProfileSession |
getProfileItemSmartProfileSession(Id profileId)
Gets the session for managing dynamic profile item profile.
|
ProfileLookupSession |
getProfileLookupSession()
Gets the OsidSession associated with the profile lookup service.
|
ProfileNotificationSession |
getProfileNotificationSession(ProfileReceiver profileReceiver)
Gets the notification session for notifications pertaining to profile
service changes.
|
ProfileQuerySession |
getProfileQuerySession()
Gets the profile query session.
|
ProfileRulesManager |
getProfileRulesManager()
Gets a
ProfileRulesManager. |
ProfileSearchSession |
getProfileSearchSession()
Gets the OsidSession associated with the profile search service.
|
ProfilingSession |
getProfilingSession()
Gets a
ProfilingSession which is responsible for
performing profile checks. |
ProfilingSession |
getProfilingSessionForProfile(Id profileId)
Gets a
ProfilingSession which is responsible for
performing profile checks for the given profile. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ProfilingSession getProfilingSession() throws OperationFailedException
ProfilingSession
which is responsible for
performing profile checks.OperationFailedException
- unable to complete requestUnimplementedException
- supportsProfiling()
is false
optional
- This method must be implemented if
supportsProfiling()
is true.
ProfilingSession getProfilingSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
ProfilingSession
which is responsible for
performing profile checks for the given profile.profileId
- the Id
of the profile a ProfilingSession
NotFoundException
- profileId
NullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsProfiling()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsProfiling()
and
supportsVisibleFederation()
are true.
ProfileEntryLookupSession getProfileEntryLookupSession() throws OperationFailedException
OsidSession
associated with the profile entry
lookup service. ProfileEntryLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileEntryLookup()
is false
optional
- This method must be implemented if
supportsProfileEntryLookup()
is true.
ProfileEntryLookupSession getProfileEntryLookupSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
OsidSession
associated with the profile entry
lookup service for the given profile.profileId
- the Id
of the profile a ProfileEntryLookupSession
NotFoundException
- profileId
not foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsProfileEntryLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProfileEntryLookup()
and
supportsVisibleFederation()
are true.
ProfileEntryQuerySession getProfileEntryQuerySession() throws OperationFailedException
OsidSession
associated with the profile entry
query service. ProfileEntryQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileEntryQuery()
is false
optional
- This method must be implemented if
supportsProfileEntryQuery()
is true.
ProfileEntryQuerySession getProfileEntryQuerySessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
OsidSession
associated with the profile entry
query service for the given profile.profileId
- the Id
of the Profile
ProfileEntryQuerySession
NotFoundException
- no Profile
found by
the given Id
NullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileEntryQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProfileEntryQuery()
and
supportsVisibleFederation()
are true
ProfileEntrySearchSession getProfileEntrySearchSession() throws OperationFailedException
OsidSession
associated with the profile entry
search service. ProfileEntrySearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileEntrySearch()
is false
optional
- This method must be implemented if
supportsProfileEntrySearch()
is true.
ProfileEntrySearchSession getProfileEntrySearchSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
OsidSession
associated with the profile entry
search service for the given profile.profileId
- the Id
of the profile a ProfileEntrySearchSession
NotFoundException
- profileId
not foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsProfileEntrySearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProfileEntrySearch()
and
supportsVisibleFederation()
are true.
ProfileEntryAdminSession getProfileEntryAdminSession() throws OperationFailedException
OsidSession
associated with the profile entry
administration service. ProfileEntryAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileEntryAdmin()
is false
optional
- This method must be implemented if
supportsProfileEntryAdmin()
is true.
ProfileEntryAdminSession getProfileEntryAdminSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
OsidSession
associated with the profile entry
admin service for the given profile.profileId
- the Id
of the profile a ProfileEntryAdminSession
NotFoundException
- profileId
not foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsProfileEntryAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProfileEntryAdmin()
and
supportsVisibleFederation()
are true.
ProfileEntryNotificationSession getProfileEntryNotificationSession(ProfileEntryReceiver profileEntryReceiver) throws OperationFailedException
profileEntryReceiver
- the profile entry receiver ProfileEntryNotificationSession
NullArgumentException
- profileEntryReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileEntryNotification()
is false
optional
- This method must be implemented if
supportsProfileEntryNotification()
is true.
ProfileEntryNotificationSession getProfileEntryNotificationSessionForProfile(ProfileEntryReceiver profileEntryReceiver, Id profileId) throws NotFoundException, OperationFailedException
OsidSession
associated with the profile entry
notification service for the given profile.profileEntryReceiver
- the profile entry receiverprofileId
- the Id
of the profile a ProfileEntryNotificationSession
NotFoundException
- profileId
not foundNullArgumentException
- profileEntryReceiver
or profileId
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsProfileEntryNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProfileEntryNotification()
and
supportsVisibleFederation()
are true.
ProfileEntryProfileSession getProfileEntryProfileSession() throws OperationFailedException
ProfileEntryProfileSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileEntryProfile()
is false
optional
- This method must be implemented if
supportsProfileEntryProfile()
is true.
ProfileEntryProfileAssignmentSession getProfileEntryProfileAssignmentSession() throws OperationFailedException
ProfileEntryProfileAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileEntryProfileAssignment()
is
false
optional
- This method must be implemented if
supportsProfileEntryProfileAssignment()
is
true.
ProfileEntrySmartProfileSession getProfileEntrySmartProfileSession(Id profileId) throws NotFoundException, OperationFailedException
profileId
- the Id
of the profile ProfileEntrySmartProfileSession
NotFoundException
- profileId
not foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileEntrySmartProfile()
is false
optional
- This method must be implemented if
supportsProfileEntrySmartProfile()
is true.
ProfileItemLookupSession getProfileItemLookupSession() throws OperationFailedException
OsidSession
associated with the profile item
lookup service. ProfileItemLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileItemLookup()
is false
optional
- This method must be implemented if
supportsProfileItemLookup()
is true.
ProfileItemLookupSession getProfileItemLookupSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
OsidSession
associated with the profile item
lookup service for the given profile.profileId
- the Id
of the profile a ProfileItemLookupSession
NotFoundException
- profileId
not foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsProfileItemLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProfileItemLookup()
and
supportsVisibleFederation()
are true.
ProfileItemQuerySession getProfileItemQuerySession() throws OperationFailedException
a ProfileItemQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileItemQuery()
is false
optional
- This method must be implemented if
supportsProfileItemQuery()
is true.
ProfileItemQuerySession getProfileItemQuerySessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
profileId
- the Id
of the profile a ProfileItemQuerySession
NotFoundException
- profileId
not foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsProfileItemQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProfileItemQuery()
and
supportsVisibleFederation()
are true.
ProfileItemSearchSession getProfileItemSearchSession() throws OperationFailedException
OsidSession
associated with the profile item
search service. ProfileItemSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileItemSearch()
is false
optional
- This method must be implemented if
supportsProfileItemSearch()
is true.
ProfileItemSearchSession getProfileItemSearchSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
OsidSession
associated with the profile item
search service for the given profile.profileId
- the Id
of the profile ProfileItemSearchSession
NotFoundException
- profileId
not foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsProfileItemSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProfileItemSearch()
and
supportsVisibleFederation()
are true.
ProfileItemAdminSession getProfileItemAdminSession() throws OperationFailedException
OsidSession
associated with the profile item
administration service. ProfileItemAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileItemAdmin()
is false
optional
- This method must be implemented if
supportsProfileItemAdmin()
is true.
ProfileItemAdminSession getProfileItemAdminSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
OsidSession
associated with the profile item
admin service for the given profile.profileId
- the Id
of the profile a ProfileItemAdminSession
NotFoundException
- profileId
not foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsProfileItemAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProfileItemAdmin()
and
supportsVisibleFederation()
are true.
ProfileItemNotificationSession getProfileItemNotificationSession(ProfileItemReceiver profileItemReceiver) throws OperationFailedException
profileItemReceiver
- the profile item receiver ProfileItemNotificationSession
NullArgumentException
- profileItemReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileItemNotification()
is false
optional
- This method must be implemented if
supportsProfileItemNotification()
is true.
ProfileItemNotificationSession getProfileItemNotificationSessionForProfile(ProfileItemReceiver profileItemReceiver, Id profileId) throws NotFoundException, OperationFailedException
OsidSession
associated with the profile item
notification service for the given profile.profileItemReceiver
- the profile item receiverprofileId
- the Id
of the profile a ProfileItemNotificationSession
NotFoundException
- profileId
not foundNullArgumentException
- profileItemReceiver
or profileId
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsProfileItemNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProfileItemNotification()
and
supportsVisibleFederation()
are true.
ProfileItemProfileSession getProfileItemProfileSession() throws OperationFailedException
ProfileItemProfileSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileItemProfile()
is false
optional
- This method must be implemented if
supportsProfileItemProfile()
is true.
ProfileItemProfileSession getProfileItemProfileAssignmentSession() throws OperationFailedException
ProfileItemProfileAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileItemProfileAssignment()
is false
optional
- This method must be implemented if
supportsProfileItemProfileAssignment()
is
true.
ProfileItemSmartProfileSession getProfileItemSmartProfileSession(Id profileId) throws NotFoundException, OperationFailedException
profileId
- the Id
of the profile ProfileItemSmartProfileSession
NotFoundException
- profileId
not foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileItemSmartProfile()
is false
optional
- This method must be implemented if
supportsProfileItemSmartProfile()
is true.
ProfileLookupSession getProfileLookupSession() throws OperationFailedException
ProfileLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProfileLookup()
is false
optional
- This method must be implemented if
supportsProfileLookup()
is true. ProfileQuerySession getProfileQuerySession() throws OperationFailedException
ProfileQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProfileQuery()
is false
optional
- This method must be implemented if
supportsProfileQuery()
is true.
ProfileSearchSession getProfileSearchSession() throws OperationFailedException
ProfileSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProfileSearch()
is false
optional
- This method must be implemented if
supportsProfileSearch()
is true. ProfileAdminSession getProfileAdminSession() throws OperationFailedException
ProfileAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProfileAdmin()
is false
optional
- This method must be implemented if
supportsProfileAdmin()
is true. ProfileNotificationSession getProfileNotificationSession(ProfileReceiver profileReceiver) throws OperationFailedException
profileReceiver
- the profile receiver ProfileNotificationSession
NullArgumentException
- profileReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileNotification() is false
optional
- This method must be implemented if
supportsProfileNotification()
is true. ProfileHierarchySession getProfileHierarchySession() throws OperationFailedException
ProfileHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileHierarchy() is false
optional
- This method must be implemented if
supportsProfileHierarchy()
is true. ProfileHierarchyDesignSession getProfileHierarchyDesignSession() throws OperationFailedException
ProfileHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileHierarchyDesign() is false
optional
- This method must be implemented if
supportsProfileHierarchyDesign()
is true. ProfileBatchManager getProfileBatchManager() throws OperationFailedException
ProfileBatchManager.
ProfileBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProfileBatch()
is false
optional
- This method must be implemented if
supportsProfileBatch()
is true. ProfileRulesManager getProfileRulesManager() throws OperationFailedException
ProfileRulesManager.
ProfileRulesManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProfileRules()
is false
optional
- This method must be implemented if
supportsProfileRules()
is true.