org.osid.relationship.rules

Interface RelationshipRulesManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, RelationshipRulesProfile, Sourceable

public interface RelationshipRulesManager
extends OsidManager, RelationshipRulesProfile

The relationship rules manager provides access to relationship rules sessions and provides interoperability tests for various aspects of this service. 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() Gets the OsidSession associated with the relationship enabler administration service.
RelationshipEnablerAdminSession	getRelationshipEnablerAdminSessionForFamily(Id familyId) Gets the OsidSession associated with the relationship enabler administration service for the given family.
RelationshipEnablerFamilyAssignmentSession	getRelationshipEnablerFamilyAssignmentSession() Gets the OsidSession associated with assigning relationship enablers to families.
RelationshipEnablerFamilySession	getRelationshipEnablerFamilySession() Gets the OsidSession to lookup relationship enabler family mappings for relationship enablers.
RelationshipEnablerLookupSession	getRelationshipEnablerLookupSession() Gets the OsidSession associated with the relationship enabler lookup service.
RelationshipEnablerLookupSession	getRelationshipEnablerLookupSessionForFamily(Id familyId) Gets the OsidSession associated with the relationship enabler lookup service for the given family.
RelationshipEnablerNotificationSession	getRelationshipEnablerNotificationSession(RelationshipEnablerReceiver relationshipEnablerReceiver) Gets the OsidSession associated with the relationship enabler notification service.
RelationshipEnablerNotificationSession	getRelationshipEnablerNotificationSessionForFamily(RelationshipEnablerReceiver relationshipEnablerReceiver, Id familyId) Gets the OsidSession associated with the relationship enabler notification service for the given family.
RelationshipEnablerQuerySession	getRelationshipEnablerQuerySession() Gets the OsidSession associated with the relationship enabler query service.
RelationshipEnablerQuerySession	getRelationshipEnablerQuerySessionForFamily(Id familyId) Gets the OsidSession associated with the relationship enabler query service for the given family.
RelationshipEnablerRuleApplicationSession	getRelationshipEnablerRuleApplicationSession() Gets the OsidSession associated with the relationship enabler assignment service to apply enablers to relationships.
RelationshipEnablerRuleApplicationSession	getRelationshipEnablerRuleApplicationSessionForFamily(Id familyId) Gets the OsidSession associated with the relationship enabler assignment service for the given relationship to apply enablers to relationships.
RelationshipEnablerRuleLookupSession	getRelationshipEnablerRuleLookupSession() Gets the OsidSession associated with the relationship enabler mapping lookup service for looking up the rules applied to the relationship.
RelationshipEnablerRuleLookupSession	getRelationshipEnablerRuleLookupSessionForFamily(Id familyId) 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() Gets the OsidSession associated with the relationship enabler search service.
RelationshipEnablerSearchSession	getRelationshipEnablerSearchSessionForFamily(Id familyId) Gets the OsidSession associated with the relationship enablers earch service for the given family.
RelationshipEnablerSmartFamilySession	getRelationshipEnablerSmartFamilySession(Id familyId) Gets the OsidSession to manage relationship enabler smart families.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                                                     throws OperationFailedException

Gets the OsidSession associated with the relationship enabler lookup service.

Returns:

a RelationshipEnablerLookupSession

Throws:

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)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

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

Parameters:

familyId - the Id of the Family

Returns:

a RelationshipEnablerLookupSession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId 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()
                                                                   throws OperationFailedException

Gets the OsidSession associated with the relationship enabler query service.

Returns:

a RelationshipEnablerQuerySession

Throws:

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)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

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

Parameters:

familyId - the Id of the Family

Returns:

a RelationshipEnablerQuerySession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId 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()
                                                                     throws OperationFailedException

Gets the OsidSession associated with the relationship enabler search service.

Returns:

a RelationshipEnablerSearchSession

Throws:

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)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

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

Parameters:

familyId - the Id of the Family

Returns:

a RelationshipEnablerSearchSession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId 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()
                                                                   throws OperationFailedException

Gets the OsidSession associated with the relationship enabler administration service.

Returns:

a RelationshipEnablerAdminSession

Throws:

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)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

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

Parameters:

familyId - the Id of the Family

Returns:

a RelationshipEnablerAdminSession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId 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)
                                                                                 throws OperationFailedException

Gets the OsidSession associated with the relationship enabler notification service.

Parameters:

relationshipEnablerReceiver - the notification callback

Returns:

a RelationshipEnablerNotificationSession

Throws:

NullArgumentException - relationshipEnablerReceiver 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)
                                                                                          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

Returns:

a RelationshipEnablerNotificationSession

Throws:

NotFoundException - no family found by the given Id

NullArgumentException - relationshipEnablerReceiver or familyId 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()
                                                                     throws OperationFailedException

Gets the OsidSession to lookup relationship enabler family mappings for relationship enablers.

Returns:

a RelationshipEnablerRelationshipSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerFamily() is false

Compliance:

optional - This method must be implemented if supportsRelationshipEnablerFamily() is true.

getRelationshipEnablerFamilyAssignmentSession

RelationshipEnablerFamilyAssignmentSession getRelationshipEnablerFamilyAssignmentSession()
                                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning relationship enablers to families.

Returns:

a RelationshipEnablerFamilyAssignmentSession

Throws:

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)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

Gets the OsidSession to manage relationship enabler smart families.

Parameters:

familyId - the Id of the Family

Returns:

a RelationshipEnablerSmartFamilySession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipEnablerSmartFamily() is false

Compliance:

optional - This method must be implemented if supportsRelationshipEnablerSmartFamily() is true.

getRelationshipEnablerRuleLookupSession

RelationshipEnablerRuleLookupSession getRelationshipEnablerRuleLookupSession()
                                                                             throws OperationFailedException

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

Returns:

a RelationshipEnablerRuleLookupSession

Throws:

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)
                                                                                      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

Returns:

a RelationshipEnablerRuleLookupSession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId 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()
                                                                                       throws OperationFailedException

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

Returns:

a RelationshipEnablerRuleApplicationSession

Throws:

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)
                                                                                                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

Returns:

a RelationshipEnablerRuleApplicationSession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId 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