public interface AssetQuerySession extends OsidSession
This session provides methods for searching among Asset
objects. The search query is constructed using the AssetQuery.
This session defines views that offer differing behaviors for searching.
Assets may have a query record indicated by their respective record
types. The query record is accessed via the AssetQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAssets()
Tests if this user can perform
Asset searches. |
AssetQuery |
getAssetQuery()
Gets an asset query.
|
AssetList |
getAssetsByQuery(AssetQuery assetQuery)
Gets a list of
Assets matching the given asset query. |
Repository |
getRepository()
Gets the
Repository associated with this session. |
Id |
getRepositoryId()
Gets the
Repository Id associated with
this session. |
void |
useFederatedRepositoryView()
Federates the view for methods in this session.
|
void |
useIsolatedRepositoryView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getRepositoryId()
Repository
Id
associated with
this session. Repository Id
associated with this sessionmandatory
- This method must be implemented. Repository getRepository() throws OperationFailedException, PermissionDeniedException
Repository
associated with this session. Repository
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchAssets()
Asset
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 useFederatedRepositoryView()
mandatory
- This method is must be implemented. void useIsolatedRepositoryView()
mandatory
- This method is must be implemented. AssetQuery getAssetQuery()
mandatory
- This method must be implemented. AssetList getAssetsByQuery(AssetQuery assetQuery) throws OperationFailedException, PermissionDeniedException
Assets
matching the given asset query.assetQuery
- the asset query AssetList
NullArgumentException
- assetQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- the assetQuery
is
not of this servicemandatory
- This method must be implemented.