public interface FileSmartDirectorySession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A FileQuery
can be retrieved from this session
and mapped to this Directory
to create a virtual collection
of files. The files may be sequenced using the FileSearchOrder
from this session.
This Directory
has a default query that matches any
file and a default search order that specifies no sequencing. The queries
may be examined using a FileQueryInspector.
The query may
be modified by converting the inspector back to a FileQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyFileQuery(FileQuery fileQuery)
Applies a file query to this directory.
|
void |
applyFileSequencing(FileSearchOrder fileSearchOrder)
Applies a file search order to this directory.
|
boolean |
canManageSmartDirectories()
Tests if this user can manage smart directories.
|
Directory |
getDirectory()
Gets the
Directory associated with this session. |
Id |
getDirectoryId()
Gets the absolute path of this directory.
|
FileQuery |
getFileQuery()
Gets a file query.
|
FileQuery |
getFileQueryFromInspector(FileQueryInspector fileQueryInspector)
Gets a file query from an inspector.
|
FileSearchOrder |
getFileSearchOrder()
Gets a file search order.
|
FileQueryInspector |
inspectFileQuery()
Gets a file query inspector for this directory.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDirectoryId()
Id
of this directorymandatory
- This method must be implemented. Directory getDirectory() throws OperationFailedException, PermissionDeniedException
Directory
associated with this session. Directory
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartDirectories()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart directory management is not
authorized, true
otherwisemandatory
- This method must be implemented. FileQuery getFileQuery()
mandatory
- This method must be implemented. FileSearchOrder getFileSearchOrder()
FileSearchOrder
is
supplied to a FileSearch
to specify the ordering of
results.mandatory
- This method must be implemented. void applyFileQuery(FileQuery fileQuery) throws OperationFailedException, PermissionDeniedException
fileQuery
- the file queryNullArgumentException
- fileQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- fileQuery
not of
this servicemandatory
- This method must be implemented. FileQueryInspector inspectFileQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyFileSequencing(FileSearchOrder fileSearchOrder) throws OperationFailedException, PermissionDeniedException
fileSearchOrder
- the file search orderNullArgumentException
- fileSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- fileSearchOrder
not of this servicemandatory
- This method must be implemented. FileQuery getFileQueryFromInspector(FileQueryInspector fileQueryInspector)
fileQueryInspector
- a file query inspectorNullArgumentException
- fileQueryInspector
is null
UnsupportedException
- fileQueryInspector
is not of this servicemandatory
- This method must be implemented.