Interface ProfileManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, ProfileProfile, Sourceable

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

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getProfileEntryConditionRecordTypes()	Gets the supported ProfileEntryCondition record types.
TypeList	getProfileEntryRecordTypes()	Gets the supported ProfileEntry record types.
TypeList	getProfileEntrySearchRecordTypes()	Gets the supported ProfileEntry search record types.
TypeList	getProfileItemRecordTypes()	Gets the supported ProfileItem record types.
TypeList	getProfileItemSearchRecordTypes()	Gets the supported ProfileItem search record types.
TypeList	getProfileRecordTypes()	Gets the supported Profile record types.
TypeList	getProfileSearchRecordTypes()	Gets the supported profile search record types.
boolean	supportsProfileAdmin()	Tests if a profile administrative service is supported.
boolean	supportsProfileBatch()	Tests if a profile batch service is supported.
boolean	supportsProfileEntryAdmin()	Tests if a profile entry administrative service is supported.
boolean	supportsProfileEntryConditionRecordType(Type profileEntryConditionRecordType)	Tests if the given ProfileEntryCondition record type is supported.
boolean	supportsProfileEntryLookup()	Tests if a profile entry lookup service is supported.
boolean	supportsProfileEntryNotification()	Tests if profile entry notification is supported.
boolean	supportsProfileEntryProfile()	Tests if retrieving mappings of profile entries and profile is supported.
boolean	supportsProfileEntryProfileAssignment()	Tests if managing mappings of profile entries and profile is supported.
boolean	supportsProfileEntryQuery()	Tests if profile entry query is supported.
boolean	supportsProfileEntryRecordType(Type profileEntryRecordType)	Tests if the given profile entry record type is supported.
boolean	supportsProfileEntryRelationshpSmartProfile()	Tests if profile entry smart profiles are available.
boolean	supportsProfileEntrySearch()	Tests if a profile entry search service is supported.
boolean	supportsProfileEntrySearchRecordType(Type profileEntrySearchRecordType)	Tests if the given profile entry search record type is supported.
boolean	supportsProfileHierarchy()	Tests if a profile hierarchy traversal is supported.
boolean	supportsProfileHierarchyDesign()	Tests if profile hierarchy design is supported.
boolean	supportsProfileItemAdmin()	Tests if a profile item administrative service is supported.
boolean	supportsProfileItemLookup()	Tests if a profile item lookup service is supported.
boolean	supportsProfileItemNotification()	Tests if profile item notification is supported.
boolean	supportsProfileItemProfile()	Tests if a profile item to profile lookup session is available.
boolean	supportsProfileItemProfileAssignment()	Tests if a profile item to profile assignment session is available.
boolean	supportsProfileItemQuery()	Tests if profile item query is supported.
boolean	supportsProfileItemRecordType(Type profileItemRecordType)	Tests if the given ProfileItem record type is supported.
boolean	supportsProfileItemSearch()	Tests if a profile item search service is supported.
boolean	supportsProfileItemSearchRecordType(Type profileItemSearchRecordType)	Tests if the given ProfileItem search record type is supported.
boolean	supportsProfileItemSmartProfile()	Tests if profile item smart profiles are available.
boolean	supportsProfileLookup()	Tests if a profile lookup service is supported.
boolean	supportsProfileNotification()	Tests if profile notification is supported.
boolean	supportsProfileQuery()	Tests if profile query is supported.
boolean	supportsProfileRecordType(Type profileRecordType)	Tests if the given Profile record type is supported.
boolean	supportsProfileRules()	Tests if a profile rules service is supported.
boolean	supportsProfileSearch()	Tests if a profile search service is supported.
boolean	supportsProfileSearchRecordType(Type profileSearchRecordType)	Tests if the given profile search record type is supported.
boolean	supportsProfiling()	Tests for the availability of a profile service which is the basic service for checking profiles.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getProfilingSession

ProfilingSession getProfilingSession()
                              throws OperationFailedException

Gets a ProfilingSession which is responsible for performing profile checks.

Returns:

a profiling session for this service

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfiling() is false

Compliance:

optional - This method must be implemented if {@code supportsProfiling()} is {@code true} .

getProfilingSessionForProfile

ProfilingSession getProfilingSessionForProfile(Id profileId)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

profileId - the Id of the profile

Returns:

a ProfilingSession

Throws:

NotFoundException - profileId

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfiling() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryLookupSession

ProfileEntryLookupSession getProfileEntryLookupSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the profile entry lookup service.

Returns:

a ProfileEntryLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileEntryLookup()} is {@code true} .

getProfileEntryLookupSessionForProfile

ProfileEntryLookupSession getProfileEntryLookupSessionForProfile(Id profileId)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

profileId - the Id of the profile

Returns:

a ProfileEntryLookupSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryQuerySession

ProfileEntryQuerySession getProfileEntryQuerySession()
                                              throws OperationFailedException

Gets the OsidSession associated with the profile entry query service.

Returns:

a ProfileEntryQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileEntryQuery()} is {@code true} .

getProfileEntryQuerySessionForProfile

ProfileEntryQuerySession getProfileEntryQuerySessionForProfile(Id profileId)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

profileId - the Id of the Profile

Returns:

a ProfileEntryQuerySession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileEntryQuery()} and {@code supportsVisibleFederation()} are {@code true}

getProfileEntrySearchSession

ProfileEntrySearchSession getProfileEntrySearchSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the profile entry search service.

Returns:

a ProfileEntrySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntrySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileEntrySearch()} is {@code true} .

getProfileEntrySearchSessionForProfile

ProfileEntrySearchSession getProfileEntrySearchSessionForProfile(Id profileId)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

profileId - the Id of the profile

Returns:

a ProfileEntrySearchSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryAdminSession

ProfileEntryAdminSession getProfileEntryAdminSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the profile entry administration service.

Returns:

a ProfileEntryAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileEntryAdmin()} is {@code true} .

getProfileEntryAdminSessionForProfile

ProfileEntryAdminSession getProfileEntryAdminSessionForProfile(Id profileId)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

profileId - the Id of the profile

Returns:

a ProfileEntryAdminSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryNotificationSession

ProfileEntryNotificationSession getProfileEntryNotificationSession(ProfileEntryReceiver profileEntryReceiver)
                                                            throws OperationFailedException

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

Parameters:

profileEntryReceiver - the profile entry receiver

Returns:

a ProfileEntryNotificationSession

Throws:

NullArgumentException - profileEntryReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileEntryNotification()} is {@code true} .

getProfileEntryNotificationSessionForProfile

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

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

Parameters:

profileEntryReceiver - the profile entry receiver

profileId - the Id of the profile

Returns:

a ProfileEntryNotificationSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileEntryReceiver or profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryProfileSession

ProfileEntryProfileSession getProfileEntryProfileSession()
                                                  throws OperationFailedException

Gets the session for retrieving profile entry to profile mappings.

Returns:

a ProfileEntryProfileSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryProfile() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileEntryProfile()} is {@code true} .

getProfileEntryProfileAssignmentSession

ProfileEntryProfileAssignmentSession getProfileEntryProfileAssignmentSession()
                                                                      throws OperationFailedException

Gets the session for assigning profile entries to profile mappings.

Returns:

a ProfileEntryProfileAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryProfileAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileEntryProfileAssignment()} is {@code true} .

getProfileEntrySmartProfileSession

ProfileEntrySmartProfileSession getProfileEntrySmartProfileSession(Id profileId)
                                                            throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic profile entry profiles.

Parameters:

profileId - the Id of the profile

Returns:

a ProfileEntrySmartProfileSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntrySmartProfile() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileEntrySmartProfile()} is {@code true} .

getProfileItemLookupSession

ProfileItemLookupSession getProfileItemLookupSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the profile item lookup service.

Returns:

a ProfileItemLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileItemLookup()} is {@code true} .

getProfileItemLookupSessionForProfile

ProfileItemLookupSession getProfileItemLookupSessionForProfile(Id profileId)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

profileId - the Id of the profile

Returns:

a ProfileItemLookupSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemLookup() or supportsVisibleFederation() is false

Compliance:

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

getProfileItemQuerySession

ProfileItemQuerySession getProfileItemQuerySession()
                                            throws OperationFailedException

Gets a profile item query session.

Returns:

a ProfileItemQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileItemQuery()} is {@code true} .

getProfileItemQuerySessionForProfile

ProfileItemQuerySession getProfileItemQuerySessionForProfile(Id profileId)
                                                      throws NotFoundException,
OperationFailedException

Gets a profile item query session for the given profile.

Parameters:

profileId - the Id of the profile

Returns:

a ProfileItemQuerySession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemQuery() or supportsVisibleFederation() is false

Compliance:

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

getProfileItemSearchSession

ProfileItemSearchSession getProfileItemSearchSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the profile item search service.

Returns:

a ProfileItemSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileItemSearch()} is {@code true} .

getProfileItemSearchSessionForProfile

ProfileItemSearchSession getProfileItemSearchSessionForProfile(Id profileId)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

profileId - the Id of the profile

Returns:

a ProfileItemSearchSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemSearch() or supportsVisibleFederation() is false

Compliance:

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

getProfileItemAdminSession

ProfileItemAdminSession getProfileItemAdminSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the profile item administration service.

Returns:

a ProfileItemAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileItemAdmin()} is {@code true} .

getProfileItemAdminSessionForProfile

ProfileItemAdminSession getProfileItemAdminSessionForProfile(Id profileId)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

profileId - the Id of the profile

Returns:

a ProfileItemAdminSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProfileItemNotificationSession

ProfileItemNotificationSession getProfileItemNotificationSession(ProfileItemReceiver profileItemReceiver)
                                                          throws OperationFailedException

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

Parameters:

profileItemReceiver - the profile item receiver

Returns:

a ProfileItemNotificationSession

Throws:

NullArgumentException - profileItemReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileItemNotification()} is {@code true} .

getProfileItemNotificationSessionForProfile

ProfileItemNotificationSession getProfileItemNotificationSessionForProfile(ProfileItemReceiver profileItemReceiver,
 Id profileId)
                                                                    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

Returns:

a ProfileItemNotificationSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileItemReceiver or profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemNotification() or supportsVisibleFederation() is false

Compliance:

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

getProfileItemProfileSession

ProfileItemProfileSession getProfileItemProfileSession()
                                                throws OperationFailedException

Gets the session for retrieving profile item to profile mappings.

Returns:

a ProfileItemProfileSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemProfile() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileItemProfile()} is {@code true} .

getProfileItemProfileAssignmentSession

ProfileItemProfileSession getProfileItemProfileAssignmentSession()
                                                          throws OperationFailedException

Gets the session for assigning profile item to profile mappings.

Returns:

a ProfileItemProfileAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemProfileAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileItemProfileAssignment()} is {@code true} .

getProfileItemSmartProfileSession

ProfileItemSmartProfileSession getProfileItemSmartProfileSession(Id profileId)
                                                          throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic profile item profile.

Parameters:

profileId - the Id of the profile

Returns:

a ProfileItemSmartProfileSession

Throws:

NotFoundException - profileId not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemSmartProfile() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileItemSmartProfile()} is {@code true} .

getProfileLookupSession

ProfileLookupSession getProfileLookupSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the profile lookup service.

Returns:

a ProfileLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileLookup()} is true.

getProfileQuerySession

ProfileQuerySession getProfileQuerySession()
                                    throws OperationFailedException

Gets the profile query session.

Returns:

a ProfileQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileQuery()} is {@code true} .

getProfileSearchSession

ProfileSearchSession getProfileSearchSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the profile search service.

Returns:

a ProfileSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileSearch()} is true.

getProfileAdminSession

ProfileAdminSession getProfileAdminSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the profile administration service.

Returns:

a ProfileAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileAdmin()} is true.

getProfileNotificationSession

ProfileNotificationSession getProfileNotificationSession(ProfileReceiver profileReceiver)
                                                  throws OperationFailedException

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

Parameters:

profileReceiver - the profile receiver

Returns:

a ProfileNotificationSession

Throws:

NullArgumentException - profileReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileNotification()} is true.

getProfileHierarchySession

ProfileHierarchySession getProfileHierarchySession()
                                            throws OperationFailedException

Gets the session traversing profile hierarchies.

Returns:

a ProfileHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileHierarchy()} is true.

getProfileHierarchyDesignSession

ProfileHierarchyDesignSession getProfileHierarchyDesignSession()
                                                        throws OperationFailedException

Gets the session designing profile hierarchies.

Returns:

a ProfileHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileHierarchyDesign()} is true.

getProfileBatchManager

ProfileBatchManager getProfileBatchManager()
                                    throws OperationFailedException

Gets a ProfileBatchManager .

Returns:

a ProfileBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileBatch()} is true.

getProfileRulesManager

ProfileRulesManager getProfileRulesManager()
                                    throws OperationFailedException

Gets a ProfileRulesManager .

Returns:

a ProfileRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileRules() is false

Compliance:

optional - This method must be implemented if {@code supportsProfileRules()} is true.