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

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.

MethodgetDirectoryId
Description

Gets the absolute path 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.
MethodcanManageSmartDirectories
Description

Tests if this user can manage smart directories. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart directory management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetFileQuery
Description

Gets a file query.

Returnosid.filing.FileQuerythe file query
CompliancemandatoryThis method must be implemented.
MethodgetFileSearchOrder
Description

Gets a file search order. The FileSearchOrder is supplied to a FileSearch to specify the ordering of results.

Returnosid.filing.FileSearchOrderthe file search order
CompliancemandatoryThis method must be implemented.
MethodapplyFileQuery
Description

Applies a file query to this directory.

Parametersosid.filing.FileQueryfileQuerythe file query
ErrorsNULL_ARGUMENT fileQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED fileQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectFileQuery
Description

Gets a file query inspector for this directory.

Returnosid.filing.FileQueryInspectorthe file query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyFileSequencing
Description

Applies a file search order to this directory.

Parametersosid.filing.FileSearchOrderfileSearchOrderthe file search order
ErrorsNULL_ARGUMENT fileSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED fileSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetFileQueryFromInspector
Description

Gets a file query from an inspector.

Parametersosid.filing.FileQueryInspectorfileQueryInspectora file query inspector
Returnosid.filing.FileQuerythe file query
ErrorsNULL_ARGUMENT fileQueryInspector is null
UNSUPPORTED fileQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.