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 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. |
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the relationship
enabler lookup service.proxy
- a proxy RelationshipEnablerLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerLookup()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerLookup()
is
true.
RelationshipEnablerLookupSession getRelationshipEnablerLookupSessionForFamily(Id familyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the relationship
enabler lookup service for the given family.familyId
- the Id
of the Family
proxy
- a proxy RelationshipEnablerLookupSession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId or proxy 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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the relationship
enabler query service.proxy
- a proxy RelationshipEnablerQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerQuery()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerQuery()
is true.
RelationshipEnablerQuerySession getRelationshipEnablerQuerySessionForFamily(Id familyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the relationship
enabler query service for the given family.familyId
- the Id
of the Family
proxy
- a proxy RelationshipEnablerQuerySession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId or proxy 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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the relationship
enabler search service.proxy
- a proxy RelationshipEnablerSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerSearch()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerSearch()
is
true.
RelationshipEnablerSearchSession getRelationshipEnablerSearchSessionForFamily(Id familyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the relationship
enablers earch service for the given family.familyId
- the Id
of the Family
proxy
- a proxy RelationshipEnablerSearchSession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId or proxy 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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the relationship
enabler administration service.proxy
- a proxy RelationshipEnablerAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerAdmin()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerAdmin()
is true.
RelationshipEnablerAdminSession getRelationshipEnablerAdminSessionForFamily(Id familyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the relationship
enabler administration service for the given family.familyId
- the Id
of the Family
proxy
- a proxy RelationshipEnablerAdminSession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId or proxy 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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the relationship
enabler notification service.relationshipEnablerReceiver
- the notification callbackproxy
- a proxy RelationshipEnablerNotificationSession
NullArgumentException
-
relationshipEnablerReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the relationship
enabler notification service for the given family.relationshipEnablerReceiver
- the notification callbackfamilyId
- the Id
of the Family
proxy
- a proxy RelationshipEnablerNotificationSession
NotFoundException
- no family found by the given
Id
NullArgumentException
-
relationshipEnablerReceiver, familyId,
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
to lookup relationship
enabler/family mappings.proxy
- a proxy RelationshipEnablerFamilySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerFamily()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerFamily()
is
true.
RelationshipEnablerFamilyAssignmentSession getRelationshipEnablerFamilyAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning
relationship enablers to families.proxy
- a proxy RelationshipEnablerFamilyAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerFamilyAssignment()
is
false
optional
- This method must be implemented if
supportsRelationshipEnablerFamilyAssignment()
is
true.
RelationshipEnablerSmartFamilySession getRelationshipEnablerSmartFamilySession(Id familyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage relationship enabler
smart families.familyId
- the Id
of the Family
proxy
- a proxy RelationshipEnablerSmartFamilySession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerSmartRelationship()
is
false
optional
- This method must be implemented if
supportsRelationshipEnablerSmartFamily()
is
true.
RelationshipEnablerRuleLookupSession getRelationshipEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the relationship
enabler mapping lookup service for looking up the rules applied to the
relationship.proxy
- a proxy RelationshipEnablerRuleLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerRuleLookup()
is
false
optional
- This method must be implemented if
supportsRelationshipEnablerRuleLookup()
is
true.
RelationshipEnablerRuleLookupSession getRelationshipEnablerRuleLookupSessionForFamily(Id familyId, Proxy proxy) 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
proxy
- a proxy RelationshipEnablerRuleLookupSession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the relationship
enabler assignment service to apply enablers to relationships.proxy
- a proxy RelationshipEnablerRuleApplicationSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerRuleApplication()
is
false
optional
- This method must be implemented if
supportsRelationshipEnablerRuleApplication()
is
true.
RelationshipEnablerRuleApplicationSession getRelationshipEnablerRuleApplicationSessionForFamily(Id familyId, Proxy proxy) 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
proxy
- a proxy RelationshipEnablerRuleApplicationSession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRelationshipEnablerRuleApplication()
and
supportsVisibleFederation()
are
true.