public interface DirectoryLookupSession extends OsidSession
This session defines methods for looking up directories in the current directory.
This session defines the following views:
Generally, the comparative view should be used for most applications as it permits operation even if there is data out of sync. Some administrative applications may need to know whether it had retrieved an entire set of objects and may sacrifice some interoperability for the sake of precision using the plenary view.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupDirectories()
Tests if this user can perform entry lookups.
|
DirectoryList |
getDirectories()
Gets the list of directories inthis directory.
|
DirectoryList |
getDirectoriesByGenusType(Type dircetoryGenusType)
Gets a
DirectoryList corresponding to the given
directory genus Type which does not include directories
of genus types derived from the specified Type. |
DirectoryList |
getDirectoriesByIds(IdList directoryIds)
Gets a
DirectoryList corresponding to the given
IdList. |
DirectoryList |
getDirectoriesByParentGenusType(Type directoryGenusType)
Gets a
DirectoryList corresponding to the given
directory genus Type and include any additional
directories with genus types derived from the specified Type. |
DirectoryList |
getDirectoriesByProvider(Id resourceId)
Gets a
DirectoryList for the given provider. |
DirectoryList |
getDirectoriesByRecordType(Type directoryRecordType)
Gets a
DirectoryList corresponding to the given
directory record Type. |
Directory |
getDirectory()
Gets the directory associated with this session.
|
Directory |
getDirectory(Id directoryId)
Gets a specified directory.
|
Id |
getDirectoryId()
Gets the
Id of this directory. |
void |
useComparativeDirectoryView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedDirectoryView()
Federates the view for methods in this session.
|
void |
useIsolatedDirectoryView()
Isolates the view for methods in this session.
|
void |
usePlenaryDirectoryView()
A complete view of the directory returns is desired.
|
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 canLookupDirectories()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeDirectoryView()
mandatory
- This method is must be implemented. void usePlenaryDirectoryView()
mandatory
- This method is must be implemented. void useFederatedDirectoryView()
mandatory
- This method is must be implemented. void useIsolatedDirectoryView()
mandatory
- This method is must be implemented. Directory getDirectory(Id directoryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
NOT_FOUND
results. Otherwise, the returned
Directory
may have a different Id
than
requested such as with a link.directoryId
- the Id
to the directoryNotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DirectoryList getDirectoriesByIds(IdList directoryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
DirectoryList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
directories specified in the Id
list, in the order of
the list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Directories
may be omitted from the list
and may present the elements in any order including returning a unique
set.directoryIds
- the list of Ids
to retrieve Directory
listNotFoundException
- an Id
was not foundNullArgumentException
- directoryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DirectoryList getDirectoriesByGenusType(Type dircetoryGenusType) throws OperationFailedException, PermissionDeniedException
DirectoryList
corresponding to the given
directory genus Type
which does not include directories
of genus types derived from the specified Type.
In
plenary mode, the returned list contains all known directories or an
error results. Otherwise, the returned list may contain only those
directories that are accessible through this session.dircetoryGenusType
- a directory genus type Directory list
NullArgumentException
- directoryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DirectoryList getDirectoriesByParentGenusType(Type directoryGenusType) throws OperationFailedException, PermissionDeniedException
DirectoryList
corresponding to the given
directory genus Type
and include any additional
directories with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
directories or an error results. Otherwise, the returned list may
contain only those directories that are accessible through this
session.directoryGenusType
- a directory genus type Directory
listNullArgumentException
- directoryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DirectoryList getDirectoriesByRecordType(Type directoryRecordType) throws OperationFailedException, PermissionDeniedException
DirectoryList
corresponding to the given
directory record Type.
The set of directories
implementing the given record type is returned.
In
plenary mode, the returned list contains all known directories or an
error results. Otherwise, the returned list may contain only those
directories that are accessible through this session.directoryRecordType
- a directory record type Directory
listNullArgumentException
- directoryRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DirectoryList getDirectoriesByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
DirectoryList
for the given provider. In plenary
mode, the returned list contains all known directories or an error
results. Otherwise, the returned list may contain only those
directories that are accessible through this session.resourceId
- a resource Id Directory
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DirectoryList getDirectories() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.