public interface DirectoryQuerySession extends OsidSession
This session provides methods for searching among Directory
objects. The search query is constructed using the
DirectoryQuery.
This session defines views that offer differing behaviors for searching.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchDirectories()
Tests if this user can perform
Directory searches. |
DirectoryList |
getDirectoriesByQuery(DirectoryQuery directoryQuery)
Gets a list of
Directory objects matching the given
directory query. |
Directory |
getDirectory()
Gets the directory associated with this session.
|
Id |
getDirectoryId()
Gets the
Id of this directory. |
DirectoryQuery |
getDirectoryQuery()
Gets a directory 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 canSearchDirectories()
Directory
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 useFederatedDirectoryView()
mandatory
- This method is must be implemented. void useIsolatedDirectoryView()
mandatory
- This method is must be implemented. DirectoryQuery getDirectoryQuery()
mandatory
- This method must be implemented. DirectoryList getDirectoriesByQuery(DirectoryQuery directoryQuery) throws OperationFailedException, PermissionDeniedException
Directory
objects matching the given
directory query.directoryQuery
- the directory query DirectoryList
NullArgumentException
- directoryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- directoryQuery
is
not of this servicemandatory
- This method must be implemented.