Interface HierarchyQuerySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

HierarchySearchSession

public interface HierarchyQuerySession
extends OsidSession

This session provides methods for searching among Hierarchies . 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

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

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.