org.osid.relationship

Interface FamilyLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface FamilyLookupSession
extends OsidSession

This session provides methods for retrieving Family objects. The Family represents a collection of relationships.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Families it can access, without breaking execution. However, an assessment may only be useful if all Families referenced by it are available, and a test-taking applicationmay sacrifice some interoperability for the sake of precision.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupFamilies() Tests if this user can perform Family lookups.
FamilyList	getFamilies() Gets all families.
FamilyList	getFamiliesByGenusType(Type familyGenusType) Gets a FamilyList corresponding to the given family genus Type which does not include families of genus types derived from the specified Type.
FamilyList	getFamiliesByIds(IdList familyIds) Gets a FamilyList corresponding to the given IdList.
FamilyList	getFamiliesByParentGenusType(Type familyGenusType) Gets a FamilyList corresponding to the given family genus Type and include any additional families with genus types derived from the specified Type.
FamilyList	getFamiliesByProvider(Id resourceId) Gets a FamilyList from the given provider.
FamilyList	getFamiliesByRecordType(Type familyRecordType) Gets a FamilyList containing the given family record Type.
Family	getFamily(Id familyId) Gets the Family specified by its Id.
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 Family returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupFamilies

boolean canLookupFamilies()

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

Returns:

false if lookup methods are 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 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.

getFamily

Family getFamily(Id familyId)
                 throws NotFoundException,
                        OperationFailedException,
                        PermissionDeniedException

Gets the Family specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Family may have a different Id than requested, such as the case where a duplicate Id was assigned to a Family and retained for compatibil

Parameters:

familyId - Id of the Family

Returns:

the family

Throws:

NotFoundException - familyId not found

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getFamiliesByIds

FamilyList getFamiliesByIds(IdList familyIds)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Gets a FamilyList corresponding to the given IdList. In plenary mode, the returned list contains all of the families specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible families may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

familyIds - the list of Ids to retrieve

Returns:

the returned Family list

Throws:

NotFoundException - an Id was not found

NullArgumentException - familyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFamiliesByGenusType

FamilyList getFamiliesByGenusType(Type familyGenusType)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets a FamilyList corresponding to the given family genus Type which does not include families of genus types derived from the specified Type. In plenary mode, the returned list contains all known families or an error results. Otherwise, the returned list may contain only those families that are accessible through this session.

Parameters:

familyGenusType - a family genus type

Returns:

the returned Family list

Throws:

NullArgumentException - familyGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFamiliesByParentGenusType

FamilyList getFamiliesByParentGenusType(Type familyGenusType)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets a FamilyList corresponding to the given family genus Type and include any additional families with genus types derived from the specified Type. In plenary mode, the returned list contains all known families or an error results. Otherwise, the returned list may contain only those families that are accessible through this session.

Parameters:

familyGenusType - a family genus type

Returns:

the returned Family list

Throws:

NullArgumentException - familyGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFamiliesByRecordType

FamilyList getFamiliesByRecordType(Type familyRecordType)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets a FamilyList containing the given family record Type. In plenary mode, the returned list contains all known families or an error results. Otherwise, the returned list may contain only those families that are accessible through this session.

Parameters:

familyRecordType - a family record type

Returns:

the returned Family list

Throws:

NullArgumentException - familyRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFamiliesByProvider

FamilyList getFamiliesByProvider(Id resourceId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets a FamilyList from the given provider. In plenary mode, the returned list contains all known families or an error results. Otherwise, the returned list may contain only those families that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Family list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFamilies

FamilyList getFamilies()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets all families. In plenary mode, the returned list contains all known families or an error results. Otherwise, the returned list may contain only those families that are accessible through this session.

Returns:

a list of families

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.