Interface ProfileRulesProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, ProfileRulesProfile, Sourceable

public interface ProfileRulesProxyManager
extends OsidProxyManager, ProfileRulesProfile

The profile rules proxy manager provides access to profile rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. The sessions included in this manager are:

• ProfileEntryEnablerLookupSession : a session to retrieve profile entry enablers
• ProfileEntryEnablerQuerySession : a session to query for profile entry enablers
• ProfileEntryEnablerSearchSession : a session to search for profile entry enablers
• ProfileEntryEnablerAdminSession : a session to create and delete profile entry enablers
• ProfileEntryEnablerNotificationSession : a session to receive notifications pertaining to profile entry enabler changes
• ProfileEntryEnablerProfileSession : a session to look up profile entry enabler profile mappings
• ProfileEntryEnablerProfileAssignmentSession : a session to manage profile entry enabler to profile mappings
• ProfileEntryEnablerSmartProfileSession : a session to manage dynamic profiles of profile entry enablers
• ProfileEntryEnablerRuleLookupSession : a session to look up profile entry enabler to profile entry mappings
• ProfileEntryEnablerRuleApplicationSession : a session to apply profile entry enablers to profile entries

Method Summary

Modifier and Type	Method	Description
ProfileEntryEnablerAdminSession	getProfileEntryEnablerAdminSession(Proxy proxy)	Gets the OsidSession associated with the profile entry enabler administration service.
ProfileEntryEnablerAdminSession	getProfileEntryEnablerAdminSessionForProfile(Id profileId, Proxy proxy)	Gets the OsidSession associated with the profile entry enabler administration service for the given profile.
ProfileEntryEnablerLookupSession	getProfileEntryEnablerLookupSession(Proxy proxy)	Gets the OsidSession associated with the profile entry enabler lookup service.
ProfileEntryEnablerLookupSession	getProfileEntryEnablerLookupSessionForProfile(Id profileId, Proxy proxy)	Gets the OsidSession associated with the profile entry enabler lookup service for the given profile.
ProfileEntryEnablerNotificationSession	getProfileEntryEnablerNotificationSession(ProfileEntryEnablerReceiver profileEntryEnablerReceiver, Proxy proxy)	Gets the OsidSession associated with the profile entry enabler notification service.
ProfileEntryEnablerNotificationSession	getProfileEntryEnablerNotificationSessionForProfile(ProfileEntryEnablerReceiver profileEntryEnablerReceiver, Id profileId, Proxy proxy)	Gets the OsidSession associated with the profile entry enabler notification service for the given profile.
ProfileEntryEnablerProfileAssignmentSession	getProfileEntryEnablerProfileAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning profile entry enablers to profiles for profile entry.
ProfileEntryEnablerProfileSession	getProfileEntryEnablerProfileSession(Proxy proxy)	Gets the OsidSession to lookup profile entry enabler/profile mappings for profile entry enablers.
ProfileEntryEnablerQuerySession	getProfileEntryEnablerQuerySession(Proxy proxy)	Gets the OsidSession associated with the profile entry enabler query service.
ProfileEntryEnablerQuerySession	getProfileEntryEnablerQuerySessionForProfile(Id profileId, Proxy proxy)	Gets the OsidSession associated with the profile entry enabler query service for the given profile.
ProfileEntryEnablerRuleApplicationSession	getProfileEntryEnablerRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the profile entry enabler assignment service to apply enablers to profiles.
ProfileEntryEnablerRuleApplicationSession	getProfileEntryEnablerRuleApplicationSessionForProfile(Id profileId, Proxy proxy)	Gets the OsidSession associated with the profile entry enabler assignment service for the given profile to apply enablers to profiles.
ProfileEntryEnablerRuleLookupSession	getProfileEntryEnablerRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the profile entry enabler mapping lookup service for looking up the rules applied to the profile.
ProfileEntryEnablerRuleLookupSession	getProfileEntryEnablerRuleLookupSessionForProfile(Id profileId, Proxy proxy)	Gets the OsidSession associated with the profile entry enabler mapping lookup service for the given profile for looking up rules applied to a profile.
ProfileEntryEnablerSearchSession	getProfileEntryEnablerSearchSession(Proxy proxy)	Gets the OsidSession associated with the profile entry enabler search service.
ProfileEntryEnablerSearchSession	getProfileEntryEnablerSearchSessionForProfile(Id profileId, Proxy proxy)	Gets the OsidSession associated with the profile entry enablers earch service for the given profile.
ProfileEntryEnablerSmartProfileSession	getProfileEntryEnablerSmartProfileSession(Id profileId, Proxy proxy)	Gets the OsidSession to manage profile entry enabler smart profiles.

Methods inherited from interface Closeable

close

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 OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

Methods inherited from interface ProfileRulesProfile

getProfileEntryEnablerRecordTypes, getProfileEntryEnablerSearchRecordTypes, supportsProfileEntryEnablerAdmin, supportsProfileEntryEnablerLookup, supportsProfileEntryEnablerNotification, supportsProfileEntryEnablerProfile, supportsProfileEntryEnablerProfileAssignment, supportsProfileEntryEnablerQuery, supportsProfileEntryEnablerRecordType, supportsProfileEntryEnablerRuleApplication, supportsProfileEntryEnablerRuleLookup, supportsProfileEntryEnablerSearch, supportsProfileEntryEnablerSearchRecordType, supportsProfileEntryEnablerSmartProfile, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getProfileEntryEnablerRecordTypes()	Gets the supported ProfileEntryEnabler record types.
TypeList	getProfileEntryEnablerSearchRecordTypes()	Gets the supported ProfileEntryEnabler search record types.
boolean	supportsProfileEntryEnablerAdmin()	Tests if a profile entry enabler administrative service is supported.
boolean	supportsProfileEntryEnablerLookup()	Tests if looking up profile entry enablers is supported.
boolean	supportsProfileEntryEnablerNotification()	Tests if a profile entry enabler notification service is supported.
boolean	supportsProfileEntryEnablerProfile()	Tests if a profile entry enabler profile lookup service is supported.
boolean	supportsProfileEntryEnablerProfileAssignment()	Tests if a profile entry enabler profile service is supported.
boolean	supportsProfileEntryEnablerQuery()	Tests if querying profile entry enablers is supported.
boolean	supportsProfileEntryEnablerRecordType(Type profileEntryEnablerRecordType)	Tests if the given ProfileEntryEnabler record type is supported.
boolean	supportsProfileEntryEnablerRuleApplication()	Tests if a profile entry enabler rule application service is supported.
boolean	supportsProfileEntryEnablerRuleLookup()	Tests if a profile entry enabler rule lookup service is supported.
boolean	supportsProfileEntryEnablerSearch()	Tests if searching profile entry enablers is supported.
boolean	supportsProfileEntryEnablerSearchRecordType(Type profileEntryEnablerSearchRecordType)	Tests if the given ProfileEntryEnabler search record type is supported.
boolean	supportsProfileEntryEnablerSmartProfile()	Tests if a profile entry enabler profile lookup service is supported.
boolean	supportsVisibleFederation()	Tests if any broker federation is exposed.

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

getProfileEntryEnablerLookupSession

ProfileEntryEnablerLookupSession getProfileEntryEnablerLookupSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the profile entry enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerLookup() is false

Compliance:

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

getProfileEntryEnablerLookupSessionForProfile

ProfileEntryEnablerLookupSession getProfileEntryEnablerLookupSessionForProfile(Id profileId,
 Proxy proxy)
                                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

profileId - the Id of the Profile

proxy - a proxy

Returns:

a ProfileEntryEnablerLookupSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerLookup() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryEnablerQuerySession

ProfileEntryEnablerQuerySession getProfileEntryEnablerQuerySession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the profile entry enabler query service.

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerQuery() is false

Compliance:

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

getProfileEntryEnablerQuerySessionForProfile

ProfileEntryEnablerQuerySession getProfileEntryEnablerQuerySessionForProfile(Id profileId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

profileId - the Id of the Profile

proxy - a proxy

Returns:

a ProfileEntryEnablerQuerySession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerQuery() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryEnablerSearchSession

ProfileEntryEnablerSearchSession getProfileEntryEnablerSearchSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the profile entry enabler search service.

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerSearch() is false

Compliance:

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

getProfileEntryEnablerSearchSessionForProfile

ProfileEntryEnablerSearchSession getProfileEntryEnablerSearchSessionForProfile(Id profileId,
 Proxy proxy)
                                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the profile entry enablers earch service for the given profile.

Parameters:

profileId - the Id of the Profile

proxy - a proxy

Returns:

a ProfileEntryEnablerSearchSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerSearch() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryEnablerAdminSession

ProfileEntryEnablerAdminSession getProfileEntryEnablerAdminSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the profile entry enabler administration service.

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerAdmin() is false

Compliance:

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

getProfileEntryEnablerAdminSessionForProfile

ProfileEntryEnablerAdminSession getProfileEntryEnablerAdminSessionForProfile(Id profileId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the profile entry enabler administration service for the given profile.

Parameters:

profileId - the Id of the Profile

proxy - a proxy

Returns:

a ProfileEntryEnablerAdminSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryEnablerNotificationSession

ProfileEntryEnablerNotificationSession getProfileEntryEnablerNotificationSession(ProfileEntryEnablerReceiver profileEntryEnablerReceiver,
 Proxy proxy)
                                                                          throws OperationFailedException

Gets the OsidSession associated with the profile entry enabler notification service.

Parameters:

profileEntryEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a ProfileEntryEnablerNotificationSession

Throws:

NullArgumentException - profileEntryEnablerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerNotification() is false

Compliance:

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

getProfileEntryEnablerNotificationSessionForProfile

ProfileEntryEnablerNotificationSession getProfileEntryEnablerNotificationSessionForProfile(ProfileEntryEnablerReceiver profileEntryEnablerReceiver,
 Id profileId,
 Proxy proxy)
                                                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

profileEntryEnablerReceiver - the notification callback

profileId - the Id of the Profile

proxy - a proxy

Returns:

a ProfileEntryEnablerNotificationSession

Throws:

NotFoundException - no profile found by the given Id

NullArgumentException - profileEntryEnablerReceiver, profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerNotification() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryEnablerProfileSession

ProfileEntryEnablerProfileSession getProfileEntryEnablerProfileSession(Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession to lookup profile entry enabler/profile mappings for profile entry enablers.

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerProfileSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerProfile() is false

Compliance:

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

getProfileEntryEnablerProfileAssignmentSession

ProfileEntryEnablerProfileAssignmentSession getProfileEntryEnablerProfileAssignmentSession(Proxy proxy)
                                                                                    throws OperationFailedException

Gets the OsidSession associated with assigning profile entry enablers to profiles for profile entry.

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerProfileAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerProfileAssignment() is false

Compliance:

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

getProfileEntryEnablerSmartProfileSession

ProfileEntryEnablerSmartProfileSession getProfileEntryEnablerSmartProfileSession(Id profileId,
 Proxy proxy)
                                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage profile entry enabler smart profiles.

Parameters:

profileId - the Id of the Profile

proxy - a proxy

Returns:

a ProfileEntryEnablerSmartProfileSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerSmartProfile() is false

Compliance:

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

getProfileEntryEnablerRuleLookupSession

ProfileEntryEnablerRuleLookupSession getProfileEntryEnablerRuleLookupSession(Proxy proxy)
                                                                      throws OperationFailedException

Gets the OsidSession associated with the profile entry enabler mapping lookup service for looking up the rules applied to the profile.

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerRuleLookup() is false

Compliance:

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

getProfileEntryEnablerRuleLookupSessionForProfile

ProfileEntryEnablerRuleLookupSession getProfileEntryEnablerRuleLookupSessionForProfile(Id profileId,
 Proxy proxy)
                                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the profile entry enabler mapping lookup service for the given profile for looking up rules applied to a profile.

Parameters:

profileId - the Id of the Profile

proxy - a proxy

Returns:

a ProfileEntryEnablerRuleLookupSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnableRuleLookup() or supportsVisibleFederation() is false

Compliance:

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

getProfileEntryEnablerRuleApplicationSession

ProfileEntryEnablerRuleApplicationSession getProfileEntryEnablerRuleApplicationSession(Proxy proxy)
                                                                                throws OperationFailedException

Gets the OsidSession associated with the profile entry enabler assignment service to apply enablers to profiles.

Parameters:

proxy - a proxy

Returns:

a ProfileEntryEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerRuleApplication() is false

Compliance:

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

getProfileEntryEnablerRuleApplicationSessionForProfile

ProfileEntryEnablerRuleApplicationSession getProfileEntryEnablerRuleApplicationSessionForProfile(Id profileId,
 Proxy proxy)
                                                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the profile entry enabler assignment service for the given profile to apply enablers to profiles.

Parameters:

profileId - the Id of the Profile

proxy - a proxy

Returns:

a ProfileEntryEnableryRuleApplicationSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

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