Package org.kuali.rice.kew.framework.document.search

Class DocumentSearchCustomizerBase

java.lang.Object
org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizerBase
All Implemented Interfaces:
DocumentSearchCustomizer
Direct Known Subclasses:
NullDocumentSearchCustomizer
public abstract class DocumentSearchCustomizerBase extends Object implements DocumentSearchCustomizer
An abstract implementation of a DocumentSearchCustomizer which classes can extend from and override the individual methods that they require in order to perform desired customization. All of the base method implementations in this class perform the default operation of doing no customization.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Constructor Details

    • DocumentSearchCustomizerBase

      public DocumentSearchCustomizerBase()

  • Method Details

    • customizeCriteria

      public DocumentSearchCriteria customizeCriteria(DocumentSearchCriteria documentSearchCriteria)
      Always returns a null reference which instructs the document search framework that the criteria was not customized.
      Specified by:
      customizeCriteria in interface DocumentSearchCustomizer
      Parameters:
      documentSearchCriteria - the criteria on which to perform customization
      Returns:
      a null reference indicating that no customization was performed

    • customizeClearCriteria

      public DocumentSearchCriteria customizeClearCriteria(DocumentSearchCriteria documentSearchCriteria)
      Always returns a null reference which instructs the document search framework that custom criteria clearing was not performed.
      Specified by:
      customizeClearCriteria in interface DocumentSearchCustomizer
      Parameters:
      documentSearchCriteria - the criteria on which to perform a customized clear
      Returns:
      a null reference indicating that no customization was performed

    • customizeResults

      public DocumentSearchResultValues customizeResults(DocumentSearchCriteria documentSearchCriteria, List<DocumentSearchResult> defaultResults)
      Always returns a null reference which instructs the document search framework that the customization of results was not performed.
      Specified by:
      customizeResults in interface DocumentSearchCustomizer
      Parameters:
      documentSearchCriteria - the search criteria
      defaultResults - the results obtained when executing the search
      Returns:
      a null reference indicating that no customization was performed

    • customizeResultSetConfiguration

      public DocumentSearchResultSetConfiguration customizeResultSetConfiguration(DocumentSearchCriteria documentSearchCriteria)
      Always returns a null reference which instructs the document search framework that the customization of result set fields was not performed.
      Specified by:
      customizeResultSetConfiguration in interface DocumentSearchCustomizer
      Parameters:
      documentSearchCriteria - the search criteria
      Returns:
      a null reference indicating that no customization was performed

    • isCustomizeCriteriaEnabled

      public boolean isCustomizeCriteriaEnabled(String documentTypeName)
      Always returns false indicating that criteria customization is disabled and should not be performed.
      Specified by:
      isCustomizeCriteriaEnabled in interface DocumentSearchCustomizer
      Parameters:
      documentTypeName - the name of the document type under consideration
      Returns:
      false to indicate that no customization should be performed

    • isCustomizeClearCriteriaEnabled

      public boolean isCustomizeClearCriteriaEnabled(String documentTypeName)
      Always returns false indicating that criteria clearing customization is disabled and should not be performed.
      Specified by:
      isCustomizeClearCriteriaEnabled in interface DocumentSearchCustomizer
      Parameters:
      documentTypeName - the name of the document type under consideration
      Returns:
      false to indicate that no customization should be performed

    • isCustomizeResultsEnabled

      public boolean isCustomizeResultsEnabled(String documentTypeName)
      Always returns false indicating that results customization is disabled and should not be performed.
      Specified by:
      isCustomizeResultsEnabled in interface DocumentSearchCustomizer
      Parameters:
      documentTypeName - the name of the document type under consideration
      Returns:
      false to indicate that no customization should be performed

    • isCustomizeResultSetFieldsEnabled

      public boolean isCustomizeResultSetFieldsEnabled(String documentTypeName)
      Always returns false indicating that result set field customization is disabled and should not be performed.
      Specified by:
      isCustomizeResultSetFieldsEnabled in interface DocumentSearchCustomizer
      Parameters:
      documentTypeName - the name of the document type under consideration
      Returns:
      false to indicate that no customization should be performed