Interface RelationshipRulesProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, RelationshipRulesProfile, Sourceable

public interface RelationshipRulesProxyManager
extends OsidProxyManager, RelationshipRulesProfile

The relationship rules proxy manager provides access to relationship 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:

• RelationshipEnablerLookupSession : a session to retrieve relationship enablers
• RelationshipEnablerQuerySession : a session to query for relationship enablers
• RelationshipEnablerSearchSession : a session to search for relationship enablers
• RelationshipEnablerAdminSession : a session to create and delete relationship enablers
• RelationshipEnablerNotificationSession : a session to receive notifications pertaining to relationship enabler changes
• RelationshipEnablerFamilySession : a session to look up relationship enabler family mappings
• RelationshipEnablerFamilyAssignmentSession : a session to manage relationship enabler to family mappings
• RelationshipEnablerSmartFamilySession : a session to manage dynamic families of relationship enablers
• RelationshipEnablerRuleLookupSession : a session to look up relationship enabler to relationship mappings
• RelationshipEnablerRuleApplicationSession : a session to apply relationship enablers to relationships

Method Summary

Modifier and Type	Method	Description
RelationshipEnablerAdminSession	getRelationshipEnablerAdminSession(Proxy proxy)	Gets the OsidSession associated with the relationship enabler administration service.
RelationshipEnablerAdminSession	getRelationshipEnablerAdminSessionForFamily(Id familyId, Proxy proxy)	Gets the OsidSession associated with the relationship enabler administration service for the given family.
RelationshipEnablerFamilyAssignmentSession	getRelationshipEnablerFamilyAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning relationship enablers to families.
RelationshipEnablerFamilySession	getRelationshipEnablerFamilySession(Proxy proxy)	Gets the OsidSession to lookup relationship enabler/family mappings.
RelationshipEnablerLookupSession	getRelationshipEnablerLookupSession(Proxy proxy)	Gets the OsidSession associated with the relationship enabler lookup service.
RelationshipEnablerLookupSession	getRelationshipEnablerLookupSessionForFamily(Id familyId, Proxy proxy)	Gets the OsidSession associated with the relationship enabler lookup service for the given family.
RelationshipEnablerNotificationSession	getRelationshipEnablerNotificationSession(RelationshipEnablerReceiver relationshipEnablerReceiver, Proxy proxy)	Gets the OsidSession associated with the relationship enabler notification service.
RelationshipEnablerNotificationSession	getRelationshipEnablerNotificationSessionForFamily(RelationshipEnablerReceiver relationshipEnablerReceiver, Id familyId, Proxy proxy)	Gets the OsidSession associated with the relationship enabler notification service for the given family.
RelationshipEnablerQuerySession	getRelationshipEnablerQuerySession(Proxy proxy)	Gets the OsidSession associated with the relationship enabler query service.
RelationshipEnablerQuerySession	getRelationshipEnablerQuerySessionForFamily(Id familyId, Proxy proxy)	Gets the OsidSession associated with the relationship enabler query service for the given family.
RelationshipEnablerRuleApplicationSession	getRelationshipEnablerRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the relationship enabler assignment service to apply enablers to relationships.
RelationshipEnablerRuleApplicationSession	getRelationshipEnablerRuleApplicationSessionForFamily(Id familyId, Proxy proxy)	Gets the OsidSession associated with the relationship enabler assignment service for the given relationship to apply enablers to relationships.
RelationshipEnablerRuleLookupSession	getRelationshipEnablerRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the relationship enabler mapping lookup service for looking up the rules applied to the relationship.
RelationshipEnablerRuleLookupSession	getRelationshipEnablerRuleLookupSessionForFamily(Id familyId, Proxy proxy)	Gets the OsidSession associated with the relationship enabler mapping lookup service for the given relationship for looking up rules applied to a relationship.
RelationshipEnablerSearchSession	getRelationshipEnablerSearchSession(Proxy proxy)	Gets the OsidSession associated with the relationship enabler search service.
RelationshipEnablerSearchSession	getRelationshipEnablerSearchSessionForFamily(Id familyId, Proxy proxy)	Gets the OsidSession associated with the relationship enablers earch service for the given family.
RelationshipEnablerSmartFamilySession	getRelationshipEnablerSmartFamilySession(Id familyId, Proxy proxy)	Gets the OsidSession to manage relationship enabler smart families.

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 RelationshipRulesProfile

getRelationshipEnablerRecordTypes, getRelationshipEnablerSearchRecordTypes, supportsRelationshipEnablerAdmin, supportsRelationshipEnablerFamily, supportsRelationshipEnablerFamilyAssignment, supportsRelationshipEnablerLookup, supportsRelationshipEnablerNotification, supportsRelationshipEnablerQuery, supportsRelationshipEnablerRecordType, supportsRelationshipEnablerRuleApplication, supportsRelationshipEnablerRuleLookup, supportsRelationshipEnablerSearch, supportsRelationshipEnablerSearchRecordType, supportsRelationshipEnablerSmartFamily, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getRelationshipEnablerRecordTypes()	Gets the supported RelationshipEnabler record types.
TypeList	getRelationshipEnablerSearchRecordTypes()	Gets the supported RelationshipEnabler search record types.
boolean	supportsRelationshipEnablerAdmin()	Tests if a relationship enabler administrative service is supported.
boolean	supportsRelationshipEnablerFamily()	Tests if a relationship enabler family lookup service is supported.
boolean	supportsRelationshipEnablerFamilyAssignment()	Tests if a relationship enabler family service is supported.
boolean	supportsRelationshipEnablerLookup()	Tests if looking up relationship enablers is supported.
boolean	supportsRelationshipEnablerNotification()	Tests if a relationship enabler notification service is supported.
boolean	supportsRelationshipEnablerQuery()	Tests if querying relationship enablers is supported.
boolean	supportsRelationshipEnablerRecordType(Type relationshipEnablerRecordType)	Tests if the given RelationshipEnabler record type is supported.
boolean	supportsRelationshipEnablerRuleApplication()	Tests if a relationship enabler rule application service is supported.
boolean	supportsRelationshipEnablerRuleLookup()	Tests if a relationship enabler rule lookup service is supported.
boolean	supportsRelationshipEnablerSearch()	Tests if searching relationship enablers is supported.
boolean	supportsRelationshipEnablerSearchRecordType(Type relationshipEnablerSearchRecordType)	Tests if the given RelationshipEnabler search record type is supported.
boolean	supportsRelationshipEnablerSmartFamily()	Tests if a relationship enabler smart family 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

getRelationshipEnablerLookupSession

RelationshipEnablerLookupSession getRelationshipEnablerLookupSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the relationship enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a RelationshipEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerLookup() is false

Compliance:

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

getRelationshipEnablerLookupSessionForFamily

RelationshipEnablerLookupSession getRelationshipEnablerLookupSessionForFamily(Id familyId,
 Proxy proxy)
                                                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the relationship enabler lookup service for the given family.

Parameters:

familyId - the Id of the Family

proxy - a proxy

Returns:

a RelationshipEnablerLookupSession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerLookup() or supportsVisibleFederation() is false

Compliance:

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

getRelationshipEnablerQuerySession

RelationshipEnablerQuerySession getRelationshipEnablerQuerySession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the relationship enabler query service.

Parameters:

proxy - a proxy

Returns:

a RelationshipEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerQuery() is false

Compliance:

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

getRelationshipEnablerQuerySessionForFamily

RelationshipEnablerQuerySession getRelationshipEnablerQuerySessionForFamily(Id familyId,
 Proxy proxy)
                                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the relationship enabler query service for the given family.

Parameters:

familyId - the Id of the Family

proxy - a proxy

Returns:

a RelationshipEnablerQuerySession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerQuery() or supportsVisibleFederation() is false

Compliance:

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

getRelationshipEnablerSearchSession

RelationshipEnablerSearchSession getRelationshipEnablerSearchSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the relationship enabler search service.

Parameters:

proxy - a proxy

Returns:

a RelationshipEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerSearch() is false

Compliance:

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

getRelationshipEnablerSearchSessionForFamily

RelationshipEnablerSearchSession getRelationshipEnablerSearchSessionForFamily(Id familyId,
 Proxy proxy)
                                                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the relationship enablers earch service for the given family.

Parameters:

familyId - the Id of the Family

proxy - a proxy

Returns:

a RelationshipEnablerSearchSession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerSearch() or supportsVisibleFederation() is false

Compliance:

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

getRelationshipEnablerAdminSession

RelationshipEnablerAdminSession getRelationshipEnablerAdminSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the relationship enabler administration service.

Parameters:

proxy - a proxy

Returns:

a RelationshipEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerAdmin() is false

Compliance:

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

getRelationshipEnablerAdminSessionForFamily

RelationshipEnablerAdminSession getRelationshipEnablerAdminSessionForFamily(Id familyId,
 Proxy proxy)
                                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the relationship enabler administration service for the given family.

Parameters:

familyId - the Id of the Family

proxy - a proxy

Returns:

a RelationshipEnablerAdminSession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

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

getRelationshipEnablerNotificationSession

RelationshipEnablerNotificationSession getRelationshipEnablerNotificationSession(RelationshipEnablerReceiver relationshipEnablerReceiver,
 Proxy proxy)
                                                                          throws OperationFailedException

Gets the OsidSession associated with the relationship enabler notification service.

Parameters:

relationshipEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a RelationshipEnablerNotificationSession

Throws:

NullArgumentException - relationshipEnablerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerNotification() is false

Compliance:

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

getRelationshipEnablerNotificationSessionForFamily

RelationshipEnablerNotificationSession getRelationshipEnablerNotificationSessionForFamily(RelationshipEnablerReceiver relationshipEnablerReceiver,
 Id familyId,
 Proxy proxy)
                                                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the relationship enabler notification service for the given family.

Parameters:

relationshipEnablerReceiver - the notification callback

familyId - the Id of the Family

proxy - a proxy

Returns:

a RelationshipEnablerNotificationSession

Throws:

NotFoundException - no family found by the given Id

NullArgumentException - relationshipEnablerReceiver, familyId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerNotification() or supportsVisibleFederation() is false

Compliance:

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

getRelationshipEnablerFamilySession

RelationshipEnablerFamilySession getRelationshipEnablerFamilySession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession to lookup relationship enabler/family mappings.

Parameters:

proxy - a proxy

Returns:

a RelationshipEnablerFamilySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerFamily() is false

Compliance:

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

getRelationshipEnablerFamilyAssignmentSession

RelationshipEnablerFamilyAssignmentSession getRelationshipEnablerFamilyAssignmentSession(Proxy proxy)
                                                                                  throws OperationFailedException

Gets the OsidSession associated with assigning relationship enablers to families.

Parameters:

proxy - a proxy

Returns:

a RelationshipEnablerFamilyAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerFamilyAssignment() is false

Compliance:

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

getRelationshipEnablerSmartFamilySession

RelationshipEnablerSmartFamilySession getRelationshipEnablerSmartFamilySession(Id familyId,
 Proxy proxy)
                                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage relationship enabler smart families.

Parameters:

familyId - the Id of the Family

proxy - a proxy

Returns:

a RelationshipEnablerSmartFamilySession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerSmartRelationship() is false

Compliance:

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

getRelationshipEnablerRuleLookupSession

RelationshipEnablerRuleLookupSession getRelationshipEnablerRuleLookupSession(Proxy proxy)
                                                                      throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a RelationshipEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerRuleLookup() is false

Compliance:

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

getRelationshipEnablerRuleLookupSessionForFamily

RelationshipEnablerRuleLookupSession getRelationshipEnablerRuleLookupSessionForFamily(Id familyId,
 Proxy proxy)
                                                                               throws NotFoundException,
OperationFailedException

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

Parameters:

familyId - the Id of the Family

proxy - a proxy

Returns:

a RelationshipEnablerRuleLookupSession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

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

getRelationshipEnablerRuleApplicationSession

RelationshipEnablerRuleApplicationSession getRelationshipEnablerRuleApplicationSession(Proxy proxy)
                                                                                throws OperationFailedException

Gets the OsidSession associated with the relationship enabler assignment service to apply enablers to relationships.

Parameters:

proxy - a proxy

Returns:

a RelationshipEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerRuleApplication() is false

Compliance:

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

getRelationshipEnablerRuleApplicationSessionForFamily

RelationshipEnablerRuleApplicationSession getRelationshipEnablerRuleApplicationSessionForFamily(Id familyId,
 Proxy proxy)
                                                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the relationship enabler assignment service for the given relationship to apply enablers to relationships.

Parameters:

familyId - the Id of the Family

proxy - a proxy

Returns:

a RelationshipEnablerRuleApplicationSession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

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