OSID Logo
OSID Specifications
filing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.DirectoryLookupSession
Implementsosid.OsidSession
Description

This session defines methods for looking up directories in the current directory.

This session defines the following views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • federated directory view: searches include entries in directories of which this directory is an ancestor
  • isolated directory view: lookups are restricted to entries in this directory only

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.

MethodgetDirectoryId
Description

Gets the Id of this directory.

Returnosid.id.Idthe Id of this directory
CompliancemandatoryThis method must be implemented.
MethodgetDirectory
Description

Gets the directory associated with this session.

Returnosid.filing.Directorythe directory associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupDirectories
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeDirectoryView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryDirectoryView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedDirectoryView
Description

Federates the view for methods in this session. A federated view will include entries in directories which are children of this directory.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedDirectoryView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this directory only.

CompliancemandatoryThis method is must be implemented.
MethodgetDirectory
Description

Gets a specified directory. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Directory may have a different Id than requested such as with a link.

Parametersosid.id.IddirectoryIdthe Id to the directory
Returnosid.filing.Directorythe directory
ErrorsNOT_FOUND directoryId is not found
NULL_ARGUMENT directoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectoriesByIds
Description

Gets a 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.

Parametersosid.id.IdListdirectoryIdsthe list of Ids to retrieve
Returnosid.filing.DirectoryListthe returned Directory list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT directoryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectoriesByGenusType
Description

Gets a 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.

Parametersosid.type.TypedircetoryGenusTypea directory genus type
Returnosid.filing.DirectoryListthe returned Directory list
ErrorsNULL_ARGUMENT directoryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectoriesByParentGenusType
Description

Gets a 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.

Parametersosid.type.TypedirectoryGenusTypea directory genus type
Returnosid.filing.DirectoryListthe returned Directory list
ErrorsNULL_ARGUMENT directoryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectoriesByRecordType
Description

Gets a 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.

Parametersosid.type.TypedirectoryRecordTypea directory record type
Returnosid.filing.DirectoryListthe returned Directory list
ErrorsNULL_ARGUMENT directoryRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectoriesByProvider
Description

Gets a 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.

Parametersosid.id.IdresourceIda resource Id
Returnosid.filing.DirectoryListthe returned Directory list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDirectories
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.

Returnosid.filing.DirectoryListthe list of directories in this directory
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.