public interface FileQuerySession extends OsidSession
This session provides methods for searching among files and directories
objects. The search query is constructed using a FileQuery.
This session defines views that offer differing behaviors when retrieving multiple objects.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchFiles()
Tests if this user can perform
File searches. |
Directory |
getDirectory()
Gets the directory associated with this session.
|
Id |
getDirectoryId()
Gets the
Id of this directory. |
FileQuery |
getFileQuery()
Gets a file query.
|
FileList |
getFilesByQuery(FileQuery fileQuery)
Gets a list of
Files matching the given file query. |
void |
useFederatedDirectoryView()
Federates the view for methods in this session.
|
void |
useIsolatedDirectoryView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDirectoryId()
Id
of this directory. Id
of this directorymandatory
- This method must be implemented. Directory getDirectory() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchFiles()
File
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. void useFederatedDirectoryView()
mandatory
- This method is must be implemented. void useIsolatedDirectoryView()
mandatory
- This method is must be implemented. FileQuery getFileQuery()
mandatory
- This method must be implemented. FileList getFilesByQuery(FileQuery fileQuery) throws OperationFailedException, PermissionDeniedException
Files
matching the given file query.fileQuery
- the file query FileList
NullArgumentException
- fileQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- fileQuery
is not
of this servicemandatory
- This method must be implemented.