public interface RelationshipFamilySession extends OsidSession
This session provides methods to retrieve Relationship
to Family
mappings. A Relationship
may
appear in multiple Family
objects. Each catalog 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 |
canLookupRelationshipFamilyMappings()
Tests if this user can perform lookups of relationship/family
mappings.
|
FamilyList |
getFamiliesByRelationship(Id relationshipId)
Gets the
Family objects mapped to a
Relationship. |
IdList |
getFamilyIdsByRelationship(Id relationshipId)
Gets the
Family Ids mapped to a
Relationship. |
IdList |
getRelationshipIdsByFamilies(IdList familyIds)
Gets the list of
Relationship Ids corresponding to a
list of Family objects. |
IdList |
getRelationshipIdsByFamily(Id familyId)
Gets the list of
Relationship Ids associated with a
Family. |
RelationshipList |
getRelationshipsByFamilies(IdList familyIds)
Gets the list of
Relationships corresponding to a list
of Family objects. |
RelationshipList |
getRelationshipsByFamily(Id familyId)
Gets the list of
Relationships associated with a
Family. |
void |
useComparativeFamilyView()
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 |
usePlenaryFamilyView()
A complete view of the
Relationship and Family
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRelationshipFamilyMappings()
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 useComparativeFamilyView()
mandatory
- This method is must be implemented. void usePlenaryFamilyView()
Relationship
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 getRelationshipIdsByFamily(Id familyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Relationship Ids
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. RelationshipList getRelationshipsByFamily(Id familyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Relationships
associated with a
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 getRelationshipIdsByFamilies(IdList familyIds) throws OperationFailedException, PermissionDeniedException
Relationship Ids
corresponding to a
list of Family
objects.familyIds
- list of family Ids
Ids
NullArgumentException
- familyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelationshipList getRelationshipsByFamilies(IdList familyIds) throws OperationFailedException, PermissionDeniedException
Relationships
corresponding to a list
of Family
objects.familyIds
- list of family Ids
NullArgumentException
- familyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getFamilyIdsByRelationship(Id relationshipId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Family
Ids
mapped to a
Relationship.
relationshipId
- Id
of a Relationship
Ids
NotFoundException
- relationshipId
is
not foundNullArgumentException
- relationshipId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FamilyList getFamiliesByRelationship(Id relationshipId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Family
objects mapped to a
Relationship.
relationshipId
- Id
of a Relationship
Ids
NotFoundException
- relationshipId
is
not foundNullArgumentException
- relationshipId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.