public interface RelationshipEnablerFamilySession extends OsidSession
This session provides methods to retrieve RelationshipEnabler
to Relationship
mappings. A
RelationshipEnabler
may appear in multiple Relationship
objects. Each relationship may have its own authorizations
governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRelationshipEnablerFamilytMappings()
Tests if this user can perform lookups of relationship enabler/family
mappings.
|
IdList |
getFamilyIdsByRelationshipEnabler(Id relationshipEnablerId)
Gets the
Family Ids mapped to a
RelationshipEnabler. |
IdList |
getRelationshipEnablerIdsByFamilies(IdList familyIds)
Gets the list of
RelationshipEnabler Ids corresponding
to a list of Families. |
IdList |
getRelationshipEnablerIdsByFamily(Id familyId)
Gets the list of
RelationshipEnablerIds associated with
a Family. |
RelationshipEnablerList |
getRelationshipEnablersByFamilies(IdList familyIds)
Gets the list of relationship enablers corresponding to a list of
Families. |
RelationshipEnablerList |
getRelationshipEnablersByFamily(Id familyId)
Gets the list of relationship enablers associated with a
Family. |
FamilyList |
getRelationshipsByRelationshipEnabler(Id relationshipEnablerId)
Gets the families mapped to a
RelationshipEnabler. |
void |
useComparativeRelationshipEnablerFamilyView()
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 |
usePlenaryRelationshipEnablerFamilyView()
A complete view of the
RelationshipEnabler and
Family returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRelationshipEnablerFamilytMappings()
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 useComparativeRelationshipEnablerFamilyView()
mandatory
- This method is must be implemented. void usePlenaryRelationshipEnablerFamilyView()
RelationshipEnabler
and
Family
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. IdList getRelationshipEnablerIdsByFamily(Id familyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RelationshipEnablerIds
associated with
a Family.
familyId
- Id
of the Family
Ids
NotFoundException
- familyId
is not
foundNullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelationshipEnablerList getRelationshipEnablersByFamily(Id familyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Family.
familyId
- Id
of the Family
NotFoundException
- familyId
is not
foundNullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getRelationshipEnablerIdsByFamilies(IdList familyIds) throws OperationFailedException, PermissionDeniedException
RelationshipEnabler Ids
corresponding
to a list of Families.
familyIds
- list of family Ids
Ids
NullArgumentException
- familyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelationshipEnablerList getRelationshipEnablersByFamilies(IdList familyIds) throws OperationFailedException, PermissionDeniedException
Families.
familyIds
- list of family Ids
NullArgumentException
- familyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getFamilyIdsByRelationshipEnabler(Id relationshipEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Family
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. FamilyList getRelationshipsByRelationshipEnabler(Id relationshipEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.