org.osid.hierarchy

Interface HierarchyQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

HierarchySearchSession

public interface HierarchyQuerySession
extends OsidSession

This session provides methods for searching among Hierarchy objects. The search query is constructed using the HierarchyQuery.

Hierarchies may have a query record indicated by their respective record types. The query record is accessed via the HierarchuQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchHierarchies() Tests if this user can perform Hierarchy searches.
HierarchyList	getHierarchiesByQuery(HierarchyQuery hierarchyQuery) Gets a list of Hierarchy objects matching the given hierarchy query.
HierarchyQuery	getHierarchyQuery() Gets a hierarchy query.

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

canSearchHierarchies

boolean canSearchHierarchies()

Tests if this user can perform Hierarchy searches. 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 search operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getHierarchyQuery

HierarchyQuery getHierarchyQuery()

Gets a hierarchy query.

Returns:

the hierarchy query

Compliance:

mandatory - This method must be implemented.

getHierarchiesByQuery

HierarchyList getHierarchiesByQuery(HierarchyQuery hierarchyQuery)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a list of Hierarchy objects matching the given hierarchy query.

Parameters:

hierarchyQuery - the hierarchy query

Returns:

the returned HierarchyList

Throws:

NullArgumentException - hierarchyQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - hierarchyQuery is not of this service

Compliance:

mandatory - This method must be implemented.