Interface HierarchySearchSession

All Superinterfaces:

AutoCloseable, Closeable, HierarchyQuerySession, OsidSession, OsidSession

public interface HierarchySearchSession
extends HierarchyQuerySession

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

getHierarchiesByQuery() is the basic search method and returns a list of Hierarchy objects. A more advanced search may be performed with getHierarchiesBySearch() . It accepts a HierarchySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getHierarchiesBySearch() returns a HierarchySearchResults that can be used to access the resulting HierarchyList or be used to perform a search within the result set through HierarchySearch .

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

Method Summary

Modifier and Type	Method	Description
HierarchySearchResults	getHierarchiesBySearch(HierarchyQuery hierarchyQuery, HierarchySearch hierarchySearch)	Gets the search results matching the given search query using the given search.
HierarchyQuery	getHierarchyQueryFromInspector(HierarchyQueryInspector hierarchyQueryInspector)	Gets a hierarchy query from an inspector.
HierarchySearch	getHierarchySearch()	Gets a hierarchy search.
HierarchySearchOrder	getHierarchySearchOrder()	Gets a hierarchy search order.

Methods inherited from interface Closeable

close

Methods inherited from interface HierarchyQuerySession

canSearchHierarchies, getHierarchiesByQuery, getHierarchyQuery

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 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

getHierarchySearch

HierarchySearch getHierarchySearch()

Gets a hierarchy search.

Returns:

the hierarchy search

Compliance:

mandatory - This method must be implemented.

getHierarchySearchOrder

HierarchySearchOrder getHierarchySearchOrder()

Gets a hierarchy search order. The HierarchySearchOrder is supplied to a HierarchySearch to specify the ordering of results.

Returns:

the hierarchy search order

Compliance:

mandatory - This method must be implemented.

getHierarchiesBySearch

HierarchySearchResults getHierarchiesBySearch(HierarchyQuery hierarchyQuery,
 HierarchySearch hierarchySearch)
                                       throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

hierarchyQuery - the hierarchy query

hierarchySearch - the hierarchy search

Returns:

the hierarchy search results

Throws:

NullArgumentException - hierarchyQuery or hierarchySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - hierarchyQuery or hierarchySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getHierarchyQueryFromInspector

HierarchyQuery getHierarchyQueryFromInspector(HierarchyQueryInspector hierarchyQueryInspector)

Gets a hierarchy query from an inspector. The inspector is available from a HierarchySearchResults .

Parameters:

hierarchyQueryInspector - a hierarchy query inspector

Returns:

the hierarchy query

Throws:

NullArgumentException - hierarchyQueryInspector is null

UnsupportedException - hierarchyQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.