org.kuali.coeus.s2sgen.impl.generate

Class S2SBaseFormGenerator

java.lang.Object

org.kuali.coeus.s2sgen.impl.generate.S2SBaseFormGenerator

All Implemented Interfaces:

S2SFormGenerator, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

AttachmentsV1_1Generator, BudgetV1_1Generator, CD511V1_1Generator, CommonSF424BaseGenerator, ED524BudgetBaseGenerator, EDAbstractBaseGenerator, EDCertificationDebarmentV1_1Generator, EDGEPA427BaseGenerator, EDSF424SupplementBaseGenerator, FaithBasedSurveyOnEEOV1_0Generator, FaithBasedSurveyOnEEOV1_1Generator, FaithBasedSurveyOnEEOV1_2Generator, GGLobbyingFormBaseGenerator, KeyContactsV1_0Generator, NASAOtherProjectInformationV1_0Generator, NasaPIandAORSupplementalDataSheetV1_0Generator, NASASeniorKeyPersonSupplementalDataSheetV1_0Generator, NSFApplicationChecklistBaseGenerator, NSFCoverPageBaseGenerator, NSFDeviationAuthorizationBaseGenerator, NSFSuggestedReviewersBaseGenerator, OtherBaseGenerator, PerformanceSiteBaseGenerator, PHS398CareerDevelopmentAwardSupBaseGenerator, PHS398ChecklistBaseGenerator, PHS398CoverLetterBaseGenerator, PHS398CoverPageSupplementBaseGenerator, PHS398FellowshipSupplementalBaseGenerator, PHS398ModularBudgetBaseGenerator, PHS398ResearchPlanBaseGenerator, PHS398ResTrainProgPlanV1_0Generator, PHS398ResTrainProgPlanV2_0Generator, PHS398TrainingBudgetV1_0Generator, PHSCoverLetterBaseGenerator, ProjectBaseGenerator, RRBudgetBaseGenerator, RRFedNonFedBudgetBaseGenerator, RRKeyPersonBase, RROtherProjectInfoBaseGenerator, RRPerformanceSiteBaseGenerator, RRPersonalDataBaseGenerator, RRSF424BV1_1Generator, S2SAdobeFormAttachmentBaseGenerator, SFLLLBaseGenerator

public abstract class S2SBaseFormGenerator
extends Object
implements S2SFormGenerator, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.BeanNameAware

This class defines the Base methods for the Form Generator classes

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AREAS_AFFECTED_ABSTRACT_TYPE_CODE
protected static int	CONGRESSIONAL_DISTRICT_MAX_LENGTH
protected static String	DEFAULT_SORT_INDEX
protected static int	DUNS_NUMBER_MAX_LENGTH
protected GlobalLibraryV1_0Generator	globLibV10Generator
protected GlobalLibraryV2_0Generator	globLibV20Generator
protected static String	KEY_VALUE_SEPARATOR
protected static String	NOT_ANSWERED
protected static int	ORGANIZATON_NAME_MAX_LENGTH
protected org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract	pdDoc
protected static int	PRIMARY_TITLE_MAX_LENGTH

Constructor Summary

Constructors

Constructor and Description
S2SBaseFormGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAttachment(AttachmentData attachment) This is for adding attachment for the forms during form generation.
void	afterPropertiesSet()
protected String	cleanFileName(String fileName)
protected static byte[]	computeAttachmentHash(byte[] attachment) This method is used to encode the hash value based on Message Digest
String	createContentId(org.kuali.coeus.propdev.api.attachment.NarrativeContract narrative) Generates the contentId or href for narrative attachments in S2S
String	createContentId(org.kuali.coeus.propdev.api.person.attachment.ProposalPersonBiographyContract biography)
protected String	getAnswer(Integer questionSeqId, List<? extends org.kuali.coeus.common.questionnaire.api.answer.AnswerHeaderContract> answerHeaders) This method is used to get the answer for a particular Questionnaire question question based on the question id.
protected Long	getAnswerId(Integer questionSeqId, List<? extends org.kuali.coeus.common.questionnaire.api.answer.AnswerHeaderContract> answerHeaders) This method is used to get the answerId for a particular Questionnaire question question based on the question id.
protected String	getAnswers(Integer questionSeqId, List<? extends org.kuali.coeus.common.questionnaire.api.answer.AnswerHeaderContract> answerHeaders)
protected gov.grants.apply.system.attachmentsV10.AttachedFileDataType	getAttachedFileDataType(String narrativeTypeCode) This method is used to get List of Other attachments from NarrativeAttachment
protected gov.grants.apply.system.attachmentsV10.AttachedFileDataType[]	getAttachedFileDataTypes(String narrativeTypeCode) This method is used to get List of Other attachments from NarrativeAttachment
protected gov.grants.apply.system.attachmentsV10.AttachedFileDataType	getAttachedFileType(org.kuali.coeus.propdev.api.attachment.NarrativeContract narrative)
List<AttachmentData>	getAttachments() Gets the list of attachments associated with a form.
List<AuditError>	getAuditErrors() Gets the auditErrors attribute.
protected String	getChildQuestionAnswer(Integer parentQuestionSeqId, Integer questionSeqId, List<? extends org.kuali.coeus.common.questionnaire.api.answer.AnswerHeaderContract> answerHeaders) This method is used to get the child question answer for a particular Questionnaire question question based on the question id.
FormMappingService	getFormMappingService()
abstract String	getFormName()
String	getGeneratorName()
GlobalLibraryV1_0Generator	getGlobLibV10Generator()
GlobalLibraryV2_0Generator	getGlobLibV20Generator()
protected gov.grants.apply.system.globalV10.HashValueDocument.HashValue	getHashValue(byte[] fileData) This method is used to generate the HashValue for a particular file stream.
abstract String	getNamespace()
org.kuali.coeus.propdev.api.attachment.NarrativeService	getNarrativeService()
abstract String	getPackageName()
protected gov.grants.apply.system.attachmentsV10.AttachedFileDataType	getPernonnelAttachments(org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract pdDoc, String personId, Integer rolodexId, String documentType) This method fetches the attachments for ProposalPersonContract.
protected org.kuali.coeus.propdev.api.person.ProposalPersonContract	getPerson(org.kuali.coeus.propdev.api.core.DevelopmentProposalContract developmentProposal, Integer proposalPersonNumber)
org.kuali.coeus.propdev.api.questionnaire.PropDevQuestionAnswerService	getPropDevQuestionAnswerService()
org.kuali.coeus.common.questionnaire.api.core.QuestionAnswerService	getQuestionAnswerService()
protected String	getS2sNarrativeFileName(org.kuali.coeus.propdev.api.attachment.NarrativeContract narrative)
protected String	getS2sPersonnelAttachmentFileName(org.kuali.coeus.propdev.api.core.DevelopmentProposalContract developmentProposal, org.kuali.coeus.propdev.api.person.attachment.ProposalPersonBiographyContract biography)
abstract int	getSortIndex()
org.kuali.coeus.common.api.sponsor.hierarchy.SponsorHierarchyService	getSponsorHierarchyService()
abstract org.springframework.core.io.Resource	getStylesheet()
protected boolean	isSponsorNIH(org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract document)
protected org.kuali.coeus.propdev.api.attachment.NarrativeContract	saveNarrative(byte[] attachment, String narrativeTypeCode, String fileName, String comment)
void	setAttachments(List<AttachmentData> attachments) Sets the attachments attribute value.
void	setAuditErrors(List<AuditError> auditErrors) Sets the auditErrors attribute value.
void	setBeanName(String beanName)
void	setFormMappingService(FormMappingService formMappingService)
void	setGlobLibV10Generator(GlobalLibraryV1_0Generator globLibV10Generator)
void	setGlobLibV20Generator(GlobalLibraryV2_0Generator globLibV20Generator)
void	setNarrativeService(org.kuali.coeus.propdev.api.attachment.NarrativeService narrativeService)
void	setPropDevQuestionAnswerService(org.kuali.coeus.propdev.api.questionnaire.PropDevQuestionAnswerService propDevQuestionAnswerService)
void	setQuestionAnswerService(org.kuali.coeus.common.questionnaire.api.core.QuestionAnswerService questionAnswerService)
void	setSponsorHierarchyService(org.kuali.coeus.common.api.sponsor.hierarchy.SponsorHierarchyService sponsorHierarchyService)
void	sortAttachments(ByteArrayInputStream byteArrayInputStream) Sort the attachments.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.coeus.s2sgen.impl.generate.S2SFormGenerator

getFormObject

Field Detail

NOT_ANSWERED

protected static final String NOT_ANSWERED

See Also:

Constant Field Values

KEY_VALUE_SEPARATOR

protected static final String KEY_VALUE_SEPARATOR

See Also:

Constant Field Values

AREAS_AFFECTED_ABSTRACT_TYPE_CODE

protected static final String AREAS_AFFECTED_ABSTRACT_TYPE_CODE

See Also:

Constant Field Values

ORGANIZATON_NAME_MAX_LENGTH

protected static final int ORGANIZATON_NAME_MAX_LENGTH

See Also:

Constant Field Values

DUNS_NUMBER_MAX_LENGTH

protected static final int DUNS_NUMBER_MAX_LENGTH

See Also:

Constant Field Values

PRIMARY_TITLE_MAX_LENGTH

protected static final int PRIMARY_TITLE_MAX_LENGTH

See Also:

Constant Field Values

CONGRESSIONAL_DISTRICT_MAX_LENGTH

protected static final int CONGRESSIONAL_DISTRICT_MAX_LENGTH

See Also:

Constant Field Values

DEFAULT_SORT_INDEX

protected static final String DEFAULT_SORT_INDEX

See Also:

Constant Field Values

pdDoc

protected org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract pdDoc

globLibV10Generator

@Autowired
@Qualifier(value="GlobalLibraryV1_0Generator")
protected GlobalLibraryV1_0Generator globLibV10Generator

globLibV20Generator

@Autowired
@Qualifier(value="GlobalLibraryV2_0Generator")
protected GlobalLibraryV2_0Generator globLibV20Generator

Constructor Detail

S2SBaseFormGenerator

public S2SBaseFormGenerator()

Method Detail

getAttachments

public List<AttachmentData> getAttachments()

Gets the list of attachments associated with a form. As the form generator fills the form data, the attachment information is stored into the instance variable

Specified by:

getAttachments in interface S2SFormGenerator

Returns:

List List of attachments associated with the the form. Returns an empty list if no attachment is available.

addAttachment

protected void addAttachment(AttachmentData attachment)

This is for adding attachment for the forms during form generation.

Parameters:

attachment - - The attachment data to add.

getHashValue

protected gov.grants.apply.system.globalV10.HashValueDocument.HashValue getHashValue(byte[] fileData)

This method is used to generate the HashValue for a particular file stream. The hashing algorithm is defined in constant S2SConstants.HASH_ALGORITHM

Parameters:

fileData - - They byte[] containing the file data.

Returns:

HashValue - The hash value calculated for the fileData input.

createContentId

public String createContentId(org.kuali.coeus.propdev.api.attachment.NarrativeContract narrative)

Generates the contentId or href for narrative attachments in S2S

createContentId

public String createContentId(org.kuali.coeus.propdev.api.person.attachment.ProposalPersonBiographyContract biography)

computeAttachmentHash

protected static final byte[] computeAttachmentHash(byte[] attachment)

This method is used to encode the hash value based on Message Digest

Parameters:

attachment -

Returns:

Base64.encode(rawDigest) (String)

getAttachedFileType

protected gov.grants.apply.system.attachmentsV10.AttachedFileDataType getAttachedFileType(org.kuali.coeus.propdev.api.attachment.NarrativeContract narrative)

getAttachedFileDataTypes

protected gov.grants.apply.system.attachmentsV10.AttachedFileDataType[] getAttachedFileDataTypes(String narrativeTypeCode)

This method is used to get List of Other attachments from NarrativeAttachment

Returns:

AttachedFileDataType[] based on the narrative type code.

getAttachedFileDataType

protected gov.grants.apply.system.attachmentsV10.AttachedFileDataType getAttachedFileDataType(String narrativeTypeCode)

This method is used to get List of Other attachments from NarrativeAttachment

Returns:

AttachedFileDataType[] based on the narrative type code.

getPernonnelAttachments

protected gov.grants.apply.system.attachmentsV10.AttachedFileDataType getPernonnelAttachments(org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract pdDoc,
                                                                                  String personId,
                                                                                  Integer rolodexId,
                                                                                  String documentType)

This method fetches the attachments for ProposalPersonContract. For a given person or rolodex ID, it will fetch the document of required type, also passed alongside as documentType

Parameters:

pdDoc - ProposalDevelopmentDocumentContract from which the attachments are to be fetched

personId - ID of the proposal person

rolodexId - Rolodex ID of the person

documentType - type of document thats to be fetched

Returns:

AttachedFileDataType containing the required document

getS2sNarrativeFileName

protected String getS2sNarrativeFileName(org.kuali.coeus.propdev.api.attachment.NarrativeContract narrative)

getS2sPersonnelAttachmentFileName

protected String getS2sPersonnelAttachmentFileName(org.kuali.coeus.propdev.api.core.DevelopmentProposalContract developmentProposal,
                                       org.kuali.coeus.propdev.api.person.attachment.ProposalPersonBiographyContract biography)

cleanFileName

protected String cleanFileName(String fileName)

getPerson

protected org.kuali.coeus.propdev.api.person.ProposalPersonContract getPerson(org.kuali.coeus.propdev.api.core.DevelopmentProposalContract developmentProposal,
                                                                  Integer proposalPersonNumber)

getAuditErrors

public List<AuditError> getAuditErrors()

Gets the auditErrors attribute.

Specified by:

getAuditErrors in interface S2SFormGenerator

Returns:

Returns the auditErrors.

setAuditErrors

public void setAuditErrors(List<AuditError> auditErrors)

Sets the auditErrors attribute value.

Parameters:

auditErrors - The auditErrors to set.

isSponsorNIH

protected boolean isSponsorNIH(org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract document)

saveNarrative

protected org.kuali.coeus.propdev.api.attachment.NarrativeContract saveNarrative(byte[] attachment,
                                                                     String narrativeTypeCode,
                                                                     String fileName,
                                                                     String comment)

setAttachments

public void setAttachments(List<AttachmentData> attachments)

Sets the attachments attribute value.

Parameters:

attachments - The attachments to set.

sortAttachments

public void sortAttachments(ByteArrayInputStream byteArrayInputStream)

Sort the attachments.

Parameters:

byteArrayInputStream -

getAnswer

protected String getAnswer(Integer questionSeqId,
               List<? extends org.kuali.coeus.common.questionnaire.api.answer.AnswerHeaderContract> answerHeaders)

This method is used to get the answer for a particular Questionnaire question question based on the question id.

Parameters:

questionSeqId - the question seq id to be passed.

Returns:

returns the answer for a particular question based on the question id passed.

getAnswerId

protected Long getAnswerId(Integer questionSeqId,
               List<? extends org.kuali.coeus.common.questionnaire.api.answer.AnswerHeaderContract> answerHeaders)

This method is used to get the answerId for a particular Questionnaire question question based on the question id.

Parameters:

questionSeqId - the question seq id to be passed.

Returns:

returns the answer for a particular question based on the question id passed.

getChildQuestionAnswer

protected String getChildQuestionAnswer(Integer parentQuestionSeqId,
                            Integer questionSeqId,
                            List<? extends org.kuali.coeus.common.questionnaire.api.answer.AnswerHeaderContract> answerHeaders)

This method is used to get the child question answer for a particular Questionnaire question question based on the question id.

Parameters:

parentQuestionSeqId - the parentQuestion id to be passed.

questionSeqId - the question id to be passed.

Returns:

returns the answer for a particular question based on the question id passed.

getAnswers

protected String getAnswers(Integer questionSeqId,
                List<? extends org.kuali.coeus.common.questionnaire.api.answer.AnswerHeaderContract> answerHeaders)

setBeanName

public void setBeanName(String beanName)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

getNamespace

public abstract String getNamespace()

getGeneratorName

public String getGeneratorName()

getFormName

public abstract String getFormName()

getStylesheet

public abstract org.springframework.core.io.Resource getStylesheet()

getPackageName

public abstract String getPackageName()

getSortIndex

public abstract int getSortIndex()

getNarrativeService

public org.kuali.coeus.propdev.api.attachment.NarrativeService getNarrativeService()

getPropDevQuestionAnswerService

public org.kuali.coeus.propdev.api.questionnaire.PropDevQuestionAnswerService getPropDevQuestionAnswerService()

getQuestionAnswerService

public org.kuali.coeus.common.questionnaire.api.core.QuestionAnswerService getQuestionAnswerService()

setNarrativeService

public void setNarrativeService(org.kuali.coeus.propdev.api.attachment.NarrativeService narrativeService)

setPropDevQuestionAnswerService

public void setPropDevQuestionAnswerService(org.kuali.coeus.propdev.api.questionnaire.PropDevQuestionAnswerService propDevQuestionAnswerService)

setQuestionAnswerService

public void setQuestionAnswerService(org.kuali.coeus.common.questionnaire.api.core.QuestionAnswerService questionAnswerService)

getSponsorHierarchyService

public org.kuali.coeus.common.api.sponsor.hierarchy.SponsorHierarchyService getSponsorHierarchyService()

setSponsorHierarchyService

public void setSponsorHierarchyService(org.kuali.coeus.common.api.sponsor.hierarchy.SponsorHierarchyService sponsorHierarchyService)

getFormMappingService

public FormMappingService getFormMappingService()

setFormMappingService

public void setFormMappingService(FormMappingService formMappingService)

getGlobLibV10Generator

public GlobalLibraryV1_0Generator getGlobLibV10Generator()

setGlobLibV10Generator

public void setGlobLibV10Generator(GlobalLibraryV1_0Generator globLibV10Generator)

getGlobLibV20Generator

public GlobalLibraryV2_0Generator getGlobLibV20Generator()

setGlobLibV20Generator

public void setGlobLibV20Generator(GlobalLibraryV2_0Generator globLibV20Generator)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Throws:

Exception