OSID Specifications
filing package
Version 3.0.0
Release Candidate Preview
filing package
Version 3.0.0
Release Candidate Preview
| Interface | osid.filing.DirectoryEntrySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Description |
An interface for specifying the order of search results. | ||
| Method | orderByName | ||
| Description |
Specifies a preference for ordering the result set by the entry name. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByPath | ||
| Description |
Specifies a preference for ordering the result set by the entry path. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByOwner | ||
| Description |
Specifies a preference for ordering the result set by the entry owner. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsOwnerSearchOrder | ||
| Description |
Tests if an agent search order is available. | ||
| Return | boolean | true if an agent search order interface is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOwnerSearchOrder | ||
| Description |
Gets an agent search order interface. | ||
| Return | osid.authentication.AgentSearchOrder | an agent search order interface | |
| Errors | UNIMPLEMENTED | supportsOwnerSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsOwnerSearchOrder()
is true. | |
| Method | orderByCreatedTime | ||
| Description |
Specifies a preference for ordering the result set by the entry creation time. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByModifiedTime | ||
| Description |
Specifies a preference for ordering the result set by the entry modification time. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByLastAccessTime | ||
| Description |
Specifies a preference for ordering the result set by the entry last access time. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |