org.osid.relationship.rules

Interface RelationshipRulesProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, 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

Methods

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

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.relationship.rules.RelationshipRulesProfile

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

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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 supportsRelationshipEnablerLookup() is 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 supportsRelationshipEnablerLookup() and supportsVisibleFederation() are 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 supportsRelationshipEnablerQuery() is 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 supportsRelationshipEnablerQuery() and supportsVisibleFederation() are 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 supportsRelationshipEnablerSearch() is 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 supportsRelationshipEnablerSearch() and supportsVisibleFederation() are 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 supportsRelationshipEnablerAdmin() is 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 supportsRelationshipEnablerAdmin() and supportsVisibleFederation() are 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 supportsRelationshipEnablerNotification() is 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 supportsRelationshipEnablerNotification() and supportsVisibleFederation() are 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 supportsRelationshipEnablerFamily() is 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 supportsRelationshipEnablerFamilyAssignment() is 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 supportsRelationshipEnablerSmartFamily() is 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 supportsRelationshipEnablerRuleLookup() is 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 supportsRelationshipEnablerRuleLookup() and supportsVisibleFederation() are 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 supportsRelationshipEnablerRuleApplication() is 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 supportsRelationshipEnablerRuleApplication() and supportsVisibleFederation() are true.