OSID Logo
OSID Specifications
relationship rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.rules.RelationshipRulesManager
Implementsosid.OsidManager
osid.relationship.rules.RelationshipRulesProfile
Description

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
MethodgetRelationshipEnablerLookupSession
Description

Gets the OsidSession associated with the relationship enabler lookup service.

Returnosid.relationship.rules.RelationshipEnablerLookupSessiona RelationshipEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerLookup() is true.
MethodgetRelationshipEnablerLookupSessionForFamily
Description

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

Parametersosid.id.IdfamilyIdthe Id of the Family
Returnosid.relationship.rules.RelationshipEnablerLookupSessiona RelationshipEnablerLookupSession
ErrorsNOT_FOUNDno Family found by the given Id
NULL_ARGUMENT familyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerLookup() and supportsVisibleFederation() are true.
MethodgetRelationshipEnablerQuerySession
Description

Gets the OsidSession associated with the relationship enabler query service.

Returnosid.relationship.rules.RelationshipEnablerQuerySessiona RelationshipEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerQuery() is true.
MethodgetRelationshipEnablerQuerySessionForFamily
Description

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

Parametersosid.id.IdfamilyIdthe Id of the Family
Returnosid.relationship.rules.RelationshipEnablerQuerySessiona RelationshipEnablerQuerySession
ErrorsNOT_FOUNDno Family found by the given Id
NULL_ARGUMENT familyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerQuery() and supportsVisibleFederation() are true.
MethodgetRelationshipEnablerSearchSession
Description

Gets the OsidSession associated with the relationship enabler search service.

Returnosid.relationship.rules.RelationshipEnablerSearchSessiona RelationshipEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerSearch() is true.
MethodgetRelationshipEnablerSearchSessionForFamily
Description

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

Parametersosid.id.IdfamilyIdthe Id of the Family
Returnosid.relationship.rules.RelationshipEnablerSearchSessiona RelationshipEnablerSearchSession
ErrorsNOT_FOUNDno Family found by the given Id
NULL_ARGUMENT familyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerSearch() and supportsVisibleFederation() are true.
MethodgetRelationshipEnablerAdminSession
Description

Gets the OsidSession associated with the relationship enabler administration service.

Returnosid.relationship.rules.RelationshipEnablerAdminSessiona RelationshipEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerAdmin() is true.
MethodgetRelationshipEnablerAdminSessionForFamily
Description

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

Parametersosid.id.IdfamilyIdthe Id of the Family
Returnosid.relationship.rules.RelationshipEnablerAdminSessiona RelationshipEnablerAdminSession
ErrorsNOT_FOUNDno Family found by the given Id
NULL_ARGUMENT familyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerAdmin() and supportsVisibleFederation() are true
MethodgetRelationshipEnablerNotificationSession
Description

Gets the OsidSession associated with the relationship enabler notification service.

Parametersosid.relationship.rules.RelationshipEnablerReceiverrelationshipEnablerReceiverthe notification callback
Returnosid.relationship.rules.RelationshipEnablerNotificationSessiona RelationshipEnablerNotificationSession
ErrorsNULL_ARGUMENT relationshipEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerNotification() is true.
MethodgetRelationshipEnablerNotificationSessionForFamily
Description

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

Parametersosid.relationship.rules.RelationshipEnablerReceiverrelationshipEnablerReceiverthe notification callback
osid.id.IdfamilyIdthe Id of the Family
Returnosid.relationship.rules.RelationshipEnablerNotificationSessiona RelationshipEnablerNotificationSession
ErrorsNOT_FOUNDno family found by the given Id
NULL_ARGUMENT relationshipEnablerReceiver or familyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerNotification() and supportsVisibleFederation() are true
MethodgetRelationshipEnablerFamilySession
Description

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

Returnosid.relationship.rules.RelationshipEnablerFamilySessiona RelationshipEnablerRelationshipSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerFamily() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerFamily() is true.
MethodgetRelationshipEnablerFamilyAssignmentSession
Description

Gets the OsidSession associated with assigning relationship enablers to families.

Returnosid.relationship.rules.RelationshipEnablerFamilyAssignmentSessiona RelationshipEnablerFamilyAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerFamilyAssignment() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerFamilyAssignment() is true.
MethodgetRelationshipEnablerSmartFamilySession
Description

Gets the OsidSession to manage relationship enabler smart families.

Parametersosid.id.IdfamilyIdthe Id of the Family
Returnosid.relationship.rules.RelationshipEnablerSmartFamilySessiona RelationshipEnablerSmartFamilySession
ErrorsNOT_FOUNDno Family found by the given Id
NULL_ARGUMENT familyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerSmartFamily() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerSmartFamily() is true.
MethodgetRelationshipEnablerRuleLookupSession
Description

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

Returnosid.relationship.rules.RelationshipEnablerRuleLookupSessiona RelationshipEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerRuleLookup() is true.
MethodgetRelationshipEnablerRuleLookupSessionForFamily
Description

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

Parametersosid.id.IdfamilyIdthe Id of the Family
Returnosid.relationship.rules.RelationshipEnablerRuleLookupSessiona RelationshipEnablerRuleLookupSession
ErrorsNOT_FOUNDno Family found by the given Id
NULL_ARGUMENT familyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerRuleLookup() and supportsVisibleFederation() are true
MethodgetRelationshipEnablerRuleApplicationSession
Description

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

Returnosid.relationship.rules.RelationshipEnablerRuleApplicationSessiona RelationshipEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerRuleApplication() is true.
MethodgetRelationshipEnablerRuleApplicationSessionForFamily
Description

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

Parametersosid.id.IdfamilyIdthe Id of the Family
Returnosid.relationship.rules.RelationshipEnablerRuleApplicationSessiona RelationshipEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Family found by the given Id
NULL_ARGUMENT familyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelationshipEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelationshipEnablerRuleApplication() and supportsVisibleFederation() are true