Class Structure

It is recommended to understand the class structure before actually implementing the plug-in. The following is the class structure:

• QueryTimeFilter interface: This is a generic interface that the filtering class has to implement. The query time authorization is defined by the interface: oracle.search.query.qta.QueryTimeFilter.

This interface has five methods:

filterDocuments()method takes in a RequestInfo object that contains the current HttpSerlvetRequest object and an array of DocumentInfo objects and returns an array of integers, indicating if the corresponding documents should be removed from the result.

pruneSource()method will be called as an optimization to prune an entire data source from the query results.

filterBrowseFolders()method takes an array of FolderInfo objects and returns an array of integers, indicating whether the corresponding folders should be shown in the browse page.

getCurrentUserName()

close()method will be called once the object is no longer required so that any resource that the object may have acquired can be released.

• QueryTimeFilterException class - Exceptions thrown by the class has to be of this type.
  
  
• RequestInfo class - Class containing HTTP request information passed to the QueryTimeFilter. Currently it will have either an HttpServletRequest object or a Map object containing String name/value pairs for the current Web Services SessionContext.
  
  
• DocumentInfo class - Class containing identifying information for one document, including the URL and title.
  
  
• FolderInfo class - Class containing identifying information for one folder, including the name and full path.