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

Class S2SFormGeneratorRetrievalServiceImpl

java.lang.Object

org.kuali.coeus.s2sgen.impl.generate.S2SFormGeneratorRetrievalServiceImpl

All Implemented Interfaces:

S2SFormGeneratorRetrievalService, org.springframework.beans.factory.InitializingBean

@Component("s2SFormGeneratorRetrievalService")
public class S2SFormGeneratorRetrievalServiceImpl
extends Object
implements S2SFormGeneratorRetrievalService, org.springframework.beans.factory.InitializingBean

This class is used as a service implementation that is used to create instances of opportunity form generator classes. It provides an abstraction level over the different generator class implementations.

Author:

Kuali Research Administration Team (kualidev@oncourse.iu.edu)

Constructor Summary

Constructors

Constructor	Description
S2SFormGeneratorRetrievalServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
<T extends org.apache.xmlbeans.XmlObject> S2SFormGenerator<T>	getS2SGenerator(String namespace)	This method is used to create and return a form generator instance.
final <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.kuali.coeus.propdev.api.s2s.UserAttachedFormService	getUserAttachedFormService()
org.apache.xmlbeans.XmlOptions	getXmlOptionsPrefixes()	This method is to get the namespace prefixes for some individual forms like, Subaward Budget and PHS398_ResearchTrainingProgramPlan
void	setUserAttachedFormService(org.kuali.coeus.propdev.api.s2s.UserAttachedFormService userAttachedFormService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

S2SFormGeneratorRetrievalServiceImpl

public S2SFormGeneratorRetrievalServiceImpl()

Method Details

getS2SGenerator

public <T extends org.apache.xmlbeans.XmlObject>
S2SFormGenerator<T> getS2SGenerator(String namespace)
                             throws S2SException

Description copied from interface: S2SFormGeneratorRetrievalService

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.

Specified by:

getS2SGenerator in interface S2SFormGeneratorRetrievalService

Parameters:

namespace - the namespace for the generator

Returns:

S2SFormGenerator form generator instances corresponding to the name space.

Throws:

S2SException

getS2SGenerator

public final <T extends org.apache.xmlbeans.XmlObject>
S2SFormGenerator<T> getS2SGenerator(String namespace,
 String proposalNumber)
                             throws S2SException

Description copied from interface: S2SFormGeneratorRetrievalService

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.

Specified by:

getS2SGenerator in interface S2SFormGeneratorRetrievalService

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:

S2SException

getS2SGenerators

public <T extends org.apache.xmlbeans.XmlObject>
List<S2SFormGenerator<T>> getS2SGenerators(Set<String> namespaces,
 String proposalNumber)
                                    throws S2SException

Description copied from interface: S2SFormGeneratorRetrievalService

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.

Specified by:

getS2SGenerators in interface S2SFormGeneratorRetrievalService

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:

S2SException

getS2SGenerators

public <T extends org.apache.xmlbeans.XmlObject>
List<S2SFormGenerator<T>> getS2SGenerators()
                                    throws S2SException

Description copied from interface: S2SFormGeneratorRetrievalService

This method is used to create and return form generators instances excluding DynamicForm types.

Specified by:

getS2SGenerators in interface S2SFormGeneratorRetrievalService

Returns:

S2SFormGenerator form generator instances corresponding to the name space.

Throws:

S2SException

getXmlOptionsPrefixes

public org.apache.xmlbeans.XmlOptions getXmlOptionsPrefixes()

Description copied from interface: S2SFormGeneratorRetrievalService

This method is to get the namespace prefixes for some individual forms like, Subaward Budget and PHS398_ResearchTrainingProgramPlan

Specified by:

getXmlOptionsPrefixes in interface S2SFormGeneratorRetrievalService

getUserAttachedFormService

public org.kuali.coeus.propdev.api.s2s.UserAttachedFormService getUserAttachedFormService()

setUserAttachedFormService

public void setUserAttachedFormService(org.kuali.coeus.propdev.api.s2s.UserAttachedFormService userAttachedFormService)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean