org.kuali.kra.s2s.generator

Class S2SBaseFormGenerator

java.lang.Object

org.kuali.kra.s2s.generator.S2SBaseFormGenerator

All Implemented Interfaces:

S2SFormGenerator

Direct Known Subclasses:

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

public abstract class S2SBaseFormGenerator
extends Object
implements S2SFormGenerator

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
static String	AREAS_AFFECTED_ABSTRACT_TYPE_CODE
protected static int	CONGRESSIONAL_DISTRICT_MAX_LENGTH
static String	DESCRIPTION
protected static int	DUNS_NUMBER_MAX_LENGTH
protected GlobalLibraryV1_0Generator	globLibV10Generator
protected GlobalLibraryV2_0Generator	globLibV20Generator
static String	KEY_VALUE_SEPARATOR
static String	MODULE_NUMBER
protected static int	ORGANIZATON_NAME_MAX_LENGTH
protected ProposalDevelopmentDocument	pdDoc
protected static int	PRIMARY_TITLE_MAX_LENGTH
static String	TITLE
static String	TYPE_SEPARATOR

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.
protected static String	computeAttachmentHash(byte[] attachment) This method is used to encode the hash value based on Message Digest
String	createContentId(Narrative narrative) Generates the contentId or href for narrative attachments in S2S
String	createContentId(ProposalPersonBiography biography)
protected gov.grants.apply.system.attachmentsV10.AttachedFileDataType	getAttachedFileDataType(String narrativeTypeCode) This method is used to get List of Other attachments from NarrativeAttachmentList
protected gov.grants.apply.system.attachmentsV10.AttachedFileDataType[]	getAttachedFileDataTypes(String narrativeTypeCode) This method is used to get List of Other attachments from NarrativeAttachmentList
protected gov.grants.apply.system.attachmentsV10.AttachedFileDataType	getAttachedFileType(Narrative narrative)
List<AttachmentData>	getAttachments() Gets the list of attachments associated with a form.
List<org.kuali.rice.kns.util.AuditError>	getAuditErrors() Gets the auditErrors attribute.
protected gov.grants.apply.system.globalV10.HashValueDocument.HashValue	getHashValue(byte[] fileData) This method is used to generate the HashValue for a particular file stream.
protected gov.grants.apply.system.attachmentsV10.AttachedFileDataType	getPernonnelAttachments(ProposalDevelopmentDocument pdDoc, String personId, Integer rolodexId, String documentType) This method fetches the attachments for ProposalPerson.
List<AnswerHeader>	getQuestionnaireAnswers(DevelopmentProposal proposal, boolean finalDoc)
protected boolean	isSponsorNIH(ProposalDevelopmentDocument document)
protected Narrative	saveNarrative(byte[] attachment, String narrativeTypeCode, String fileName, String comment)
void	setAttachments(List<AttachmentData> attachments) Sets the attachments attribute value.
void	setAuditErrors(List<org.kuali.rice.kns.util.AuditError> auditErrors) Sets the auditErrors attribute value.
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.kra.s2s.generator.S2SFormGenerator

getFormObject

Field Detail

TYPE_SEPARATOR

public static final String TYPE_SEPARATOR

See Also:

Constant Field Values

KEY_VALUE_SEPARATOR

public static final String KEY_VALUE_SEPARATOR

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

TITLE

public static final String TITLE

See Also:

Constant Field Values

MODULE_NUMBER

public static final String MODULE_NUMBER

See Also:

Constant Field Values

AREAS_AFFECTED_ABSTRACT_TYPE_CODE

public 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

pdDoc

protected ProposalDevelopmentDocument pdDoc

globLibV10Generator

protected GlobalLibraryV1_0Generator globLibV10Generator

globLibV20Generator

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(Narrative narrative)

Generates the contentId or href for narrative attachments in S2S

Parameters:

type -

moduleNumber -

desc -

Returns:

createContentId

public String createContentId(ProposalPersonBiography biography)

computeAttachmentHash

protected static final String 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(Narrative narrative)

getAttachedFileDataTypes

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

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

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 NarrativeAttachmentList

Returns:

AttachedFileDataType[] based on the narrative type code.

getPernonnelAttachments

protected gov.grants.apply.system.attachmentsV10.AttachedFileDataType getPernonnelAttachments(ProposalDevelopmentDocument pdDoc,
                                                                                  String personId,
                                                                                  Integer rolodexId,
                                                                                  String documentType)

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

Parameters:

pdDoc - ProposalDevelopmentDocument 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

getAuditErrors

public List<org.kuali.rice.kns.util.AuditError> getAuditErrors()

Gets the auditErrors attribute.

Specified by:

getAuditErrors in interface S2SFormGenerator

Returns:

Returns the auditErrors.

setAuditErrors

public void setAuditErrors(List<org.kuali.rice.kns.util.AuditError> auditErrors)

Sets the auditErrors attribute value.

Parameters:

auditErrors - The auditErrors to set.

isSponsorNIH

protected boolean isSponsorNIH(ProposalDevelopmentDocument document)

saveNarrative

protected Narrative 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.

getQuestionnaireAnswers

public List<AnswerHeader> getQuestionnaireAnswers(DevelopmentProposal proposal,
                                         boolean finalDoc)

sortAttachments

public void sortAttachments(ByteArrayInputStream byteArrayInputStream)

Sort the attachments.

Parameters:

byteArrayInputStream. -