Interface DirectorySearch

All Superinterfaces:
Extensible, OsidCondition, OsidSearch, Suppliable
public interface DirectorySearch extends OsidSearch

The search interface for gioverning directory searches.

An example to find directories whose name is "Library" sorted by the path name. 

DirectoryQuery query = session.getDirectoryQuery();
query.addNameMatch("Library", wordStringMatchType, true);

DirectorySearch search = session.getDirectorySearch();
search.orderByPath();

DirectorySearchResults results = session.getDirectoriesBySearch(query, search);
DirectoryList directories = results.getDirectories();

  • Method Details

    • searchAmongDirectories

      void searchAmongDirectories(IdList directoryIds)
      Execute this search among the given list of diectories.
      Parameters:
      directoryIds - list of directory Ids
      Throws:
      NullArgumentException - directoryIds is null
      Compliance:
      mandatory - This method must be implemented.

    • orderDirectoryResults

      void orderDirectoryResults(DirectorySearchOrder directorySearchOrder)
      Specify an ordering to the search results.
      Parameters:
      directorySearchOrder - directory search order
      Throws:
      NullArgumentException - directorySearchOrder is null
      UnsupportedException - directorySearchOrder is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getDirectorySearchRecord

      DirectorySearchRecord getDirectorySearchRecord(Type directorySearchRecordType) throws OperationFailedException
      Gets the directory search record corresponding to the given directory search record Type. This method is used to retrieve an object implementing the requested record.
      Parameters:
      directorySearchRecordType - a directory search record type
      Returns:
      the directory search record
      Throws:
      NullArgumentException - directorySearchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(directorySearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.