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.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchHierarchies()
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. HierarchyQuery getHierarchyQuery()
mandatory
- This method must be implemented. HierarchyList getHierarchiesByQuery(HierarchyQuery hierarchyQuery) throws OperationFailedException, PermissionDeniedException
Hierarchy
objects matching the given
hierarchy query.hierarchyQuery
- the hierarchy query HierarchyList
NullArgumentException
- hierarchyQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- hierarchyQuery
is
not of this servicemandatory
- This method must be implemented.