Interface RelationshipFamilySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupRelationshipFamilyMappings

boolean canLookupRelationshipFamilyMappings()

Tests if this user can perform lookups of relationship/family mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeFamilyView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryFamilyView

void usePlenaryFamilyView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

getRelationshipIdsByFamily

IdList getRelationshipIdsByFamily(Id familyId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Relationship Ids associated with a Family .

Parameters:

familyId - Id of the Family

Returns:

list of related relationship Ids

Throws:

NotFoundException - familyId is not found

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelationshipsByFamily

RelationshipList getRelationshipsByFamily(Id familyId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Relationships associated with a Family .

Parameters:

familyId - Id of the Family

Returns:

list of related relationships

Throws:

NotFoundException - familyId is not found

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelationshipIdsByFamilies

IdList getRelationshipIdsByFamilies(IdList familyIds)
                             throws OperationFailedException,
PermissionDeniedException

Gets the list of Relationship Ids corresponding to a list of Family objects.

Parameters:

familyIds - list of family Ids

Returns:

list of relationship Ids

Throws:

NullArgumentException - familyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelationshipsByFamilies

RelationshipList getRelationshipsByFamilies(IdList familyIds)
                                     throws OperationFailedException,
PermissionDeniedException

Gets the list of Relationships corresponding to a list of Family objects.

Parameters:

familyIds - list of family Ids

Returns:

list of relationships

Throws:

NullArgumentException - familyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFamilyIdsByRelationship

IdList getFamilyIdsByRelationship(Id relationshipId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Family Ids mapped to a Relationship .

Parameters:

relationshipId - Id of a Relationship

Returns:

list of family Ids

Throws:

NotFoundException - relationshipId is not found

NullArgumentException - relationshipId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFamiliesByRelationship

FamilyList getFamiliesByRelationship(Id relationshipId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Family objects mapped to a Relationship .

Parameters:

relationshipId - Id of a Relationship

Returns:

list of family Ids

Throws:

NotFoundException - relationshipId is not found

NullArgumentException - relationshipId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.