public interface ResourceQuerySession extends OsidSession
This session provides methods for searching among Resource
objects. The search query is constructed using the
ResourceQuery.
This session defines views that offer differing behaviors for searching.
Resources may have a resource record indicated by their respective
record types. The resource query record is accessed via the
ResourceQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchResources()
Tests if this user can perform
Resource searches. |
Bin |
getBin()
Gets the
Bin associated with this session. |
Id |
getBinId()
Gets the
Bin Id associated with this
session. |
ResourceQuery |
getResourceQuery()
Gets a resource query.
|
ResourceList |
getResourcesByQuery(ResourceQuery resourceQuery)
Gets a list of
Resources matching the given resource
query. |
void |
useFederatedBinView()
Federates the view for methods in this session.
|
void |
useIsolatedBinView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBinId()
Bin
Id
associated with this
session. Bin Id
associated with this sessionmandatory
- This method must be implemented. Bin getBin() throws OperationFailedException, PermissionDeniedException
Bin
associated with this session. Bin
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchResources()
Resource
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 search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedBinView()
mandatory
- This method is must be implemented. void useIsolatedBinView()
mandatory
- This method is must be implemented. ResourceQuery getResourceQuery()
mandatory
- This method must be implemented. ResourceList getResourcesByQuery(ResourceQuery resourceQuery) throws OperationFailedException, PermissionDeniedException
Resources
matching the given resource
query.resourceQuery
- the resource query ResourceList
NullArgumentException
- resourceQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- resourceQuery
is
not of this servicemandatory
- This method must be implemented.