OSID Logo
OSID Specifications
filing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.DirectoryEntrySearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the order of search results.

MethodorderByName
Description

Specifies a preference for ordering the result set by the entry name.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByPath
Description

Specifies a preference for ordering the result set by the entry path.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByOwner
Description

Specifies a preference for ordering the result set by the entry owner.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsOwnerSearchOrder
Description

Tests if an agent search order is available.

Returnboolean true if an agent search order interface is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOwnerSearchOrder
Description

Gets an agent search order interface.

Returnosid.authentication.AgentSearchOrderan agent search order interface
ErrorsUNIMPLEMENTED supportsOwnerSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsOwnerSearchOrder() is true.
MethodorderByCreatedTime
Description

Specifies a preference for ordering the result set by the entry creation time.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByModifiedTime
Description

Specifies a preference for ordering the result set by the entry modification time.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByLastAccessTime
Description

Specifies a preference for ordering the result set by the entry last access time.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.