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 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. |
changeBranch, initialize, rollbackService
close
getRelationshipEnablerRecordTypes, getRelationshipEnablerSearchRecordTypes, supportsRelationshipEnablerAdmin, supportsRelationshipEnablerFamily, supportsRelationshipEnablerFamilyAssignment, supportsRelationshipEnablerLookup, supportsRelationshipEnablerNotification, supportsRelationshipEnablerQuery, supportsRelationshipEnablerRecordType, supportsRelationshipEnablerRuleApplication, supportsRelationshipEnablerRuleLookup, supportsRelationshipEnablerSearch, supportsRelationshipEnablerSearchRecordType, supportsRelationshipEnablerSmartFamily, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
RelationshipEnablerLookupSession getRelationshipEnablerLookupSession() throws OperationFailedException
OsidSession
associated with the relationship
enabler lookup service. RelationshipEnablerLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerLookup()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerLookup()
is
true.
RelationshipEnablerLookupSession getRelationshipEnablerLookupSessionForFamily(Id familyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the relationship
enabler lookup service for the given family.familyId
- the Id
of the Family
RelationshipEnablerLookupSession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerLookup()
and
supportsVisibleFederation()
are true.
RelationshipEnablerQuerySession getRelationshipEnablerQuerySession() throws OperationFailedException
OsidSession
associated with the relationship
enabler query service. RelationshipEnablerQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerQuery()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerQuery()
is true.
RelationshipEnablerQuerySession getRelationshipEnablerQuerySessionForFamily(Id familyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the relationship
enabler query service for the given family.familyId
- the Id
of the Family
RelationshipEnablerQuerySession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerQuery()
and
supportsVisibleFederation()
are true.
RelationshipEnablerSearchSession getRelationshipEnablerSearchSession() throws OperationFailedException
OsidSession
associated with the relationship
enabler search service. RelationshipEnablerSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerSearch()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerSearch()
is
true.
RelationshipEnablerSearchSession getRelationshipEnablerSearchSessionForFamily(Id familyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the relationship
enablers earch service for the given family.familyId
- the Id
of the Family
RelationshipEnablerSearchSession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerSearch()
and
supportsVisibleFederation()
are true.
RelationshipEnablerAdminSession getRelationshipEnablerAdminSession() throws OperationFailedException
OsidSession
associated with the relationship
enabler administration service. RelationshipEnablerAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerAdmin()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerAdmin()
is true.
RelationshipEnablerAdminSession getRelationshipEnablerAdminSessionForFamily(Id familyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the relationship
enabler administration service for the given family.familyId
- the Id
of the Family
RelationshipEnablerAdminSession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerAdmin()
and
supportsVisibleFederation()
are true
RelationshipEnablerNotificationSession getRelationshipEnablerNotificationSession(RelationshipEnablerReceiver relationshipEnablerReceiver) throws OperationFailedException
OsidSession
associated with the relationship
enabler notification service.relationshipEnablerReceiver
- the notification callback RelationshipEnablerNotificationSession
NullArgumentException
-
relationshipEnablerReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerNotification()
is
false
optional
- This method must be implemented if
supportsRelationshipEnablerNotification()
is
true.
RelationshipEnablerNotificationSession getRelationshipEnablerNotificationSessionForFamily(RelationshipEnablerReceiver relationshipEnablerReceiver, Id familyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the relationship
enabler notification service for the given family.relationshipEnablerReceiver
- the notification callbackfamilyId
- the Id
of the Family
RelationshipEnablerNotificationSession
NotFoundException
- no family found by the given
Id
NullArgumentException
-
relationshipEnablerReceiver
or familyId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerNotification()
and
supportsVisibleFederation()
are true
RelationshipEnablerFamilySession getRelationshipEnablerFamilySession() throws OperationFailedException
OsidSession
to lookup relationship enabler
family mappings for relationship enablers. RelationshipEnablerRelationshipSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerFamily()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerFamily()
is
true.
RelationshipEnablerFamilyAssignmentSession getRelationshipEnablerFamilyAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
relationship enablers to families. RelationshipEnablerFamilyAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerFamilyAssignment()
is
false
optional
- This method must be implemented if
supportsRelationshipEnablerFamilyAssignment()
is
true.
RelationshipEnablerSmartFamilySession getRelationshipEnablerSmartFamilySession(Id familyId) throws NotFoundException, OperationFailedException
OsidSession
to manage relationship enabler
smart families.familyId
- the Id of the Family
RelationshipEnablerSmartFamilySession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerSmartFamily()
is
false
optional
- This method must be implemented if
supportsRelationshipEnablerSmartFamily()
is
true.
RelationshipEnablerRuleLookupSession getRelationshipEnablerRuleLookupSession() throws OperationFailedException
OsidSession
associated with the relationship
enabler mapping lookup service for looking up the rules applied to the
relationship. RelationshipEnablerRuleLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerRuleLookup()
is
false
optional
- This method must be implemented if
supportsRelationshipEnablerRuleLookup()
is
true.
RelationshipEnablerRuleLookupSession getRelationshipEnablerRuleLookupSessionForFamily(Id familyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the relationship
enabler mapping lookup service for the given relationship for looking
up rules applied to a relationship.familyId
- the Id
of the Family
RelationshipEnablerRuleLookupSession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerRuleLookup()
and
supportsVisibleFederation()
are true
RelationshipEnablerRuleApplicationSession getRelationshipEnablerRuleApplicationSession() throws OperationFailedException
OsidSession
associated with the relationship
enabler assignment service to apply enablers to relationships. RelationshipEnablerRuleApplicationSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerRuleApplication()
is
false
optional
- This method must be implemented if
supportsRelationshipEnablerRuleApplication()
is
true.
RelationshipEnablerRuleApplicationSession getRelationshipEnablerRuleApplicationSessionForFamily(Id familyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the relationship
enabler assignment service for the given relationship to apply
enablers to relationships.familyId
- the Id
of the Family
RelationshipEnablerRuleApplicationSession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerRuleApplication()
and
supportsVisibleFederation()
are true