Package org.kuali.rice.kew.api.document.attribute

Interface DocumentAttributeIndexingQueue

public interface DocumentAttributeIndexingQueue
Defines the contract for a message queue that handles indexing of workflow documents. The indexing process is intended to look at the content associated with the workflow document and extra requested attributes for indexing alongside the document. These values can then be accessed and/or searched.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    indexDocument(String documentId)
    Perform document attribute indexing on the document with the given id.

  • Method Details

    • indexDocument

      void indexDocument(String documentId) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Perform document attribute indexing on the document with the given id. The given document id must be valid, otherwise a RiceIllegalArgumentException will be thrown.
      Parameters:
      documentId - the id of the document to index, cannot be a null or blank value and must be an accurate identifier for an existing document
      Throws:
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the given document id is a null or blank value, or if it does not resolve to a valid document