Package org.kuali.coeus.propdev.api.attachment

Interface NarrativeService

public interface NarrativeService

  • Method Details

    • deleteAutoGeneratedNarratives

      void deleteAutoGeneratedNarratives(List<? extends NarrativeContract> narratives)
      Given a collection of narratives, each narratives that was "auto-generated" will be deleted from the proposal development system of record.
      Parameters:
      narratives - the collection of narratives. Cannot be null.
      Throws:
      IllegalArgumentException - if narratives collection is null

    • isAutoGeneratedNarrative

      boolean isAutoGeneratedNarrative(NarrativeContract narrative)
      Checks if a narrative is "auto-generated".
      Parameters:
      narrative - the narrative. Cannot be null.
      Returns:
      true if the narrative is "auto-generated"
      Throws:
      IllegalArgumentException - if narrative is null

    • createSystemGeneratedNarrative

      NarrativeContract createSystemGeneratedNarrative(String proposalNumber, String narrativeTypeCode, byte[] attachmentData, String attachmentName, String comments)
      This method creates a system generated narrative. Save it to the system of record. None of the parameters can be null or blank.
      Parameters:
      proposalNumber - the proposal number which the narrative is associated with. Cannot be blank.
      narrativeTypeCode - the narrative type code. Cannot be blank.
      attachmentData - the attachment data. Cannot be blank (null or empty array)
      attachmentName - the name of the attachment. Cannot be blank.
      comments - the comments on the narrative. Cannot be blank.
      Returns:
      the created and saved narrative. Will not return null.

    • deleteSystemGeneratedNarratives

      void deleteSystemGeneratedNarratives(List<? extends NarrativeContract> narratives)
      Given a collection of narratives, each narratives that was "system-generated" will be deleted from the proposal development system of record.
      Parameters:
      narratives - the collection of narratives. Cannot be null.
      Throws:
      IllegalArgumentException - if narratives collection is null

    • isSystemGeneratedNarrative

      boolean isSystemGeneratedNarrative(NarrativeContract narrative)
      Checks if a narrative is "system-generated".
      Parameters:
      narrative - the narrative. Cannot be null.
      Returns:
      true if the narrative is "auto-generated"
      Throws:
      IllegalArgumentException - if narrative is null