Package org.kuali.coeus.s2sgen.api.generate

Interface FormGeneratorService

public interface FormGeneratorService
This service allows s2s form generation or form validation.

  • Method Details

    • generateAndValidateForms

      FormGenerationResult generateAndValidateForms(org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract pdDoc) throws S2SException
      This service method executes form generation for a given proposal development document. The proposal development document cannot be null. Note that validation is also executed as well.
      Parameters:
      pdDoc - the proposal development document. cannot be null.
      Returns:
      the result of the generation.
      Throws:
      S2SException - if unable to validate
      IllegalArgumentException - if the pdDoc is null

    • generateAndValidateMPForms

      MultiProjectFormGenerationResult generateAndValidateMPForms(org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract parent, List<org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract> children) throws S2SException
      This service method executes form generation for a complex project complete structure. It should be passed both the parent proposal in a hierarchy and all children. Validation is also executed against each form and the entire application xml via GG.
      Parameters:
      parent - The parent node in a hierarchy
      children - All children in a hierarchy
      Returns:
      The validation result, attachments and full application xml
      Throws:
      S2SException - if unable to validate

    • generateAndValidateMPComponentForms

      MultiProjectFormGenerationResult generateAndValidateMPComponentForms(org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract child, String parentSchemaUrl) throws S2SException
      This service method executes form generation for a single component (child) in a complex project. It should be passed only a single child in a hierarchy. Validation is executed against each form, but not against the resulting xml. The returned applicationXml is only valid for an nih validateComponent call.
      Parameters:
      child - The component to validate, must be a child node in a hierarchy
      Returns:
      The validation result, attachments and component xml
      Throws:
      S2SException - if unable to validate

    • validateUserAttachedFormFile

      FormGenerationResult validateUserAttachedFormFile(org.kuali.coeus.propdev.api.s2s.S2sUserAttachedFormFileContract s2sUserAttachedFormFile, String formName) throws S2SException
      This service method executes user attach form file validation. The user attached from form file cannot be null.
      Parameters:
      s2sUserAttachedFormFile - the user attached form file. cannot be null.
      formName - is the formName. cannot be null.
      Returns:
      the result of the validation
      Throws:
      S2SException - if unable to validate
      IllegalArgumentException - if the s2sUserAttachedFormFile is null or if the formName is null.