Package org.kuali.coeus.s2sgen.impl.generate

Interface S2SFormGeneratorRetrievalService

All Known Implementing Classes:
S2SFormGeneratorRetrievalServiceImpl
public interface S2SFormGeneratorRetrievalService
This interface defines the service that is used to create instances of opportunity form generator classes.
Author:
Kuali Research Administration Team (kualidev@oncourse.iu.edu)

  • Method Summary

    Modifier and Type
    Method
    Description
    <T extends org.apache.xmlbeans.XmlObject>
    S2SFormGenerator<T>
    getS2SGenerator(String namespace)
    This method is used to create and return a form generator instance.
    <T extends org.apache.xmlbeans.XmlObject>
    S2SFormGenerator<T>
    getS2SGenerator(String namespace, String proposalNumber)
    This method is used to create and return a form generator instance.
    <T extends org.apache.xmlbeans.XmlObject>
    List<S2SFormGenerator<T>>
    getS2SGenerators()
    This method is used to create and return form generators instances excluding DynamicForm types.
    <T extends org.apache.xmlbeans.XmlObject>
    List<S2SFormGenerator<T>>
    getS2SGenerators(Set<String> namespaces, String proposalNumber)
    This method is used to create and return form generators instances.
    org.apache.xmlbeans.XmlOptions
    getXmlOptionsPrefixes()
    This method is to get the namespace prefixes for some individual forms like, Subaward Budget and PHS398_ResearchTrainingProgramPlan

  • Method Details

    • getS2SGenerator

      <T extends org.apache.xmlbeans.XmlObject> S2SFormGenerator<T> getS2SGenerator(String namespace) throws org.kuali.coeus.s2sgen.api.core.S2SException
      This method is used to create and return a form generator instance. Based on the namespace provided as parameter, it instantiates the respective generator class and returns it.
      Parameters:
      namespace - the namespace for the generator
      Returns:
      S2SFormGenerator form generator instances corresponding to the name space.
      Throws:
      org.kuali.coeus.s2sgen.api.core.S2SException

    • getS2SGenerator

      <T extends org.apache.xmlbeans.XmlObject> S2SFormGenerator<T> getS2SGenerator(String namespace, String proposalNumber) throws org.kuali.coeus.s2sgen.api.core.S2SException
      This method is used to create and return a form generator instance. Based on the namespace provided as parameter, it instantiates the respective generator class and returns it.
      Parameters:
      namespace - the namespace for the generator
      proposalNumber - a proposal number which is used to first find if a user attached form exists matching the namespace.
      Returns:
      S2SFormGenerator form generator instances corresponding to the name space.
      Throws:
      org.kuali.coeus.s2sgen.api.core.S2SException

    • getS2SGenerators

      <T extends org.apache.xmlbeans.XmlObject> List<S2SFormGenerator<T>> getS2SGenerators(Set<String> namespaces, String proposalNumber) throws org.kuali.coeus.s2sgen.api.core.S2SException
      This method is used to create and return form generators instances. Based on the namespaces provided as parameter, it instantiates the respective generator class and returns it. The generators in the list are ordered by the generators sort index.
      Parameters:
      namespaces - a set of namespaces
      proposalNumber - a proposal number which is used to first find if user attached forms exist matching the namespaces.
      Returns:
      S2SFormGenerator form generator instances corresponding to the name space.
      Throws:
      org.kuali.coeus.s2sgen.api.core.S2SException

    • getS2SGenerators

      <T extends org.apache.xmlbeans.XmlObject> List<S2SFormGenerator<T>> getS2SGenerators() throws org.kuali.coeus.s2sgen.api.core.S2SException
      This method is used to create and return form generators instances excluding DynamicForm types.
      Returns:
      S2SFormGenerator form generator instances corresponding to the name space.
      Throws:
      org.kuali.coeus.s2sgen.api.core.S2SException

    • getXmlOptionsPrefixes

      org.apache.xmlbeans.XmlOptions getXmlOptionsPrefixes()
      This method is to get the namespace prefixes for some individual forms like, Subaward Budget and PHS398_ResearchTrainingProgramPlan