Interface | osid.filing.DirectoryLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
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. | ||
Method | getDirectoryId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Id of this directory | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectory | ||
Description |
Gets the directory associated with this session. | ||
Return | osid.filing.Directory | the directory associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupDirectories | ||
Description |
Tests if this user can perform entry lookups. 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 | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeDirectoryView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryDirectoryView | ||
Description |
A complete view of the directory returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedDirectoryView | ||
Description |
Federates the view for methods in this session. A federated view will include entries in directories which are children of this directory. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedDirectoryView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this directory only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getDirectory | ||
Description |
Gets a specified directory. In plenary mode, the exact
Id is found or a | ||
Parameters | osid.id.Id | directoryId | the Id to the directory |
Return | osid.filing.Directory | the directory | |
Errors | NOT_FOUND | directoryId is not found | |
NULL_ARGUMENT | directoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectoriesByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | directoryIds | the list of Ids to retrieve |
Return | osid.filing.DirectoryList | the returned Directory list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | directoryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectoriesByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | dircetoryGenusType | a directory genus type |
Return | osid.filing.DirectoryList | the returned Directory list | |
Errors | NULL_ARGUMENT | directoryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectoriesByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | directoryGenusType | a directory genus type |
Return | osid.filing.DirectoryList | the returned Directory list | |
Errors | NULL_ARGUMENT | directoryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectoriesByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | directoryRecordType | a directory record type |
Return | osid.filing.DirectoryList | the returned Directory list | |
Errors | NULL_ARGUMENT | directoryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectoriesByProvider | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.filing.DirectoryList | the returned Directory list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectories | ||
Description |
Gets the list of directories inthis directory. In a federated view, this method returns all directories in descendant directories. 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. | ||
Return | osid.filing.DirectoryList | the list of directories in this directory | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |