public interface RelationshipEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve RelationshipEnabler
to Relationship
mappings. A Relationship
with multiple RelationshipEnablers
means any
positive rule evaluation across the enablers result in an enabled
Relationship.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRelationshipEnablerRules()
Tests if this user can perform lookups of relationship
enabler/relationship mappings.
|
Family |
getFamily()
Gets the
Family associated with this session. |
Id |
getFamilyId()
Gets the
Family Id associated with this
session. |
IdList |
getRelationshipEnablerIdsForRelationship(Id relationshipId)
Gets the
RelationshipEnabler Id associated with a
Relationship. |
RelationshipEnablerList |
getRelationshipEnablersForRelationship(Id relationshipId)
Gets the
RelationshipEnabler associated with a
Relationship. |
IdList |
getRelationshipIdsForRelationshipEnabler(Id relationshipEnablerId)
Gets the
Relationship Ids mapped to a
RelationshipEnabler. |
RelationshipList |
getRelationshipsForRelationshipEnabler(Id relationshipEnablerId)
Gets the
Relationships mapped to a
RelationshipEnabler. |
void |
useComparativeRelationshipEnablerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedFamilyView()
Federates the view for methods in this session.
|
void |
useIsolatedFamilyView()
Isolates the view for methods in this session.
|
void |
usePlenaryRelationshipEnablerRuleView()
A complete view of the
RelationshipEnabler and
Relationship returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFamilyId()
Family
Id
associated with this
session. Family Id
associated with this sessionmandatory
- This method must be implemented. Family getFamily() throws OperationFailedException, PermissionDeniedException
Family
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupRelationshipEnablerRules()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeRelationshipEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryRelationshipEnablerRuleView()
RelationshipEnabler
and
Relationship
returns is desired. Methods will return what is
requested or result in an error. This view is used when greater
precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. void useFederatedFamilyView()
mandatory
- This method is must be implemented. void useIsolatedFamilyView()
mandatory
- This method is must be implemented. IdList getRelationshipEnablerIdsForRelationship(Id relationshipId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RelationshipEnabler Id
associated with a
Relationship.
relationshipId
- Id
of the Relationship
Ids
NotFoundException
- relationshipId
is
not foundNullArgumentException
- relationshipId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelationshipEnablerList getRelationshipEnablersForRelationship(Id relationshipId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RelationshipEnabler
associated with a
Relationship.
relationshipId
- Id
of the Relationship
NotFoundException
- relationshipId
is
not foundNullArgumentException
- relationshipId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getRelationshipIdsForRelationshipEnabler(Id relationshipEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Relationship
Ids
mapped to a
RelationshipEnabler.
relationshipEnablerId
- Id
of a
RelationshipEnabler
Ids
NotFoundException
- relationshipEnablerId
is not foundNullArgumentException
- relationshipEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelationshipList getRelationshipsForRelationshipEnabler(Id relationshipEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Relationships
mapped to a
RelationshipEnabler.
relationshipEnablerId
- Id
of a
RelationshipEnabler
NotFoundException
- relationshipEnablerId
is not foundNullArgumentException
- relationshipEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.