org.osid.hierarchy

Interface HierarchyLookupSession

All Superinterfaces:

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

public interface HierarchyLookupSession
extends OsidSession

This session provides methods for retrieving Hierarchy objects. The Hierarchy represents a structure of OSID Ids.

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 Hierarchies objects it can access, without breaking execution. However, an assessment may only be useful if all Hierarchy objects 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	canLookupHierarchies() Tests if this user can perform Hierarchy lookups.
HierarchyList	getHierarchies() Gets all hierarchies.
HierarchyList	getHierarchiesByGenusType(Type hierarchyGenusType) Gets a HierarchyList corresponding to the given genus Type which does not include hierarchies of types derived from the specified Type.
HierarchyList	getHierarchiesByIds(IdList hierarchyIds) Gets a Hierarchy corresponding to the given IdList.
HierarchyList	getHierarchiesByParentGenusType(Type hierarchyGenusType) Gets a HierarchyList corresponding to the given hierarchy genus Type and include any additional hierarchies with types derived from the specified Type.
HierarchyList	getHierarchiesByProvider(Id resourceId) Gets a HierarchyList for the given provider .
HierarchyList	getHierarchiesByRecordType(Type hierarchyRecordType) Gets a HierarchyList corresponding to the given hierarchy record Type.
Hierarchy	getHierarchy(Id hierarchyId) Gets the Hierarchy specified by its Id.
void	useComparativeHierarchyView() 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	usePlenaryHierarchyView() A complete view of the Hierarchy 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

canLookupHierarchies

boolean canLookupHierarchies()

Tests if this user can perform Hierarchy 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 opt not to offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeHierarchyView

void useComparativeHierarchyView()

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.

usePlenaryHierarchyView

void usePlenaryHierarchyView()

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

getHierarchy

Hierarchy getHierarchy(Id hierarchyId)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

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

Parameters:

hierarchyId - the Id of the Hierarchy to retrieve

Returns:

the returned Hierarchy

Throws:

NotFoundException - no Hierarchy found with the given Id

NullArgumentException - hierarchyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHierarchiesByIds

HierarchyList getHierarchiesByIds(IdList hierarchyIds)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets a Hierarchy corresponding to the given IdList. In plenary mode, the returned list contains all of the hierarchies 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 Hierarchy objects may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

hierarchyIds - the list of Ids to retrieve

Returns:

the returned Hierarchy list

Throws:

NotFoundException - an Id was not found

NullArgumentException - hierarchyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHierarchiesByGenusType

HierarchyList getHierarchiesByGenusType(Type hierarchyGenusType)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

hierarchyGenusType - a hierarchy genus type

Returns:

the returned Hierarchy list

Throws:

NullArgumentException - hierarchyGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHierarchiesByParentGenusType

HierarchyList getHierarchiesByParentGenusType(Type hierarchyGenusType)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

hierarchyGenusType - a hierarchy genus type

Returns:

the returned Hierarchy list

Throws:

NullArgumentException - hierarchyGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHierarchiesByRecordType

HierarchyList getHierarchiesByRecordType(Type hierarchyRecordType)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets a HierarchyList corresponding to the given hierarchy record Type. The set of hierarchies implementing the given record type are returned. In plenary mode, the returned list contains all known hierarchies or an error results. Otherwise, the returned list may contain only those hierarchies that are accessible through this session.

Parameters:

hierarchyRecordType - a hierarchy record type

Returns:

the returned Hierarchy list

Throws:

NullArgumentException - hierarchyRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHierarchiesByProvider

HierarchyList getHierarchiesByProvider(Id resourceId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a HierarchyList for the given provider . The set of hierarchies implementing the given record type are returned. In plenary mode, the returned list contains all known hierarchies or an error results. Otherwise, the returned list may contain only those hierarchies that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Hierarchy list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHierarchies

HierarchyList getHierarchies()
                             throws OperationFailedException,
                                    PermissionDeniedException

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

Returns:

a list of Hierarchies

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.