org.kuali.kra.s2s.service.impl

Class KRAS2SServiceImpl

java.lang.Object

org.kuali.kra.s2s.service.impl.KRAS2SServiceImpl

All Implemented Interfaces:

S2SService

public class KRAS2SServiceImpl
extends Object
implements S2SService

This class is implementation of S2SService

Author:

Kuali Research Administration Team

Constructor Summary

Constructors

Constructor and Description
KRAS2SServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkForSubmissionStatusChange(ProposalDevelopmentDocument pdDoc, S2sAppSubmission appSubmission) This method checks if status on grants.gov has changed since last check and returns the status.
protected S2sOpportunity	convert2S2sOpportunity(String providerCode, OpportunityInformationType oppInfoType) This method convert OpportunityInformationType to OpportunityInfo
protected ArrayList<S2sOpportunity>	convertToArrayList(String source, GetOpportunityListResponse resList) This method convert GetOpportunityListResponse to ArrayList
GetApplicationListResponse	fetchApplicationListResponse(ProposalDevelopmentDocument pdDoc) This method fetches the application list from Grants.gov for a given proposal
protected boolean	generateAndValidateForms(gov.grants.apply.system.metaGrantApplication.GrantApplicationDocument.GrantApplication.Forms forms, List<AttachmentData> attList, ProposalDevelopmentDocument pdDoc)
protected boolean	generateAndValidateForms(gov.grants.apply.system.metaGrantApplication.GrantApplicationDocument.GrantApplication.Forms forms, List<AttachmentData> attList, ProposalDevelopmentDocument pdDoc, List<org.kuali.rice.kns.util.AuditError> auditErrors) This method is to generate and validate the generated forms.
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService() Gets the businessObjectService attribute.
org.kuali.rice.core.api.datetime.DateTimeService	getDateTimeService() Gets the dateTimeService attribute.
protected String	getGrantApplicationDocument(ProposalDevelopmentDocument pdDoc, gov.grants.apply.system.metaGrantApplication.GrantApplicationDocument.GrantApplication.Forms forms) This method populates values for GrantApplicationDocument for a given ProposalDevelopmentDocument
PrintService	getPrintService() Gets the printService attribute.
protected S2SConnectorService	getS2sConnectorService(S2sOpportunity s2sOpportunity)
S2SFormGeneratorService	getS2SFormGeneratorService() Gets the s2SFormGeneratorService attribute.
S2SProposalValidatorService	getS2SProposalValidatorService() Gets the s2SProposalValidatorService attribute.
S2SUtilService	getS2sUtilService() Gets the s2sUtilService attribute.
S2SValidatorService	getS2SValidatorService() Gets the s2SValidatorService attribute.
String	getStatusDetails(String ggTrackingId, String proposalNumber) This method is used to get the application status details.
List<S2sOppForms>	parseOpportunityForms(S2sOpportunity opportunity) This method returns the list of forms for a given opportunity
void	populateAppSubmission(ProposalDevelopmentDocument pdDoc, S2sAppSubmission appSubmission, ApplicationInformationType ggApplication) This method populates the S2sAppSubmission BO with details from ApplicationInformationType
void	populateSponsorProposalId(ProposalDevelopmentDocument pdDoc, S2sAppSubmission appSubmission) Takes the appSubmission and proposal and if a federal tracking id has been specified, will set on both the proposal development doc and the related institutional proposal doc if there is not a sponsor proposal id already.
AttachmentDataSource	printForm(ProposalDevelopmentDocument pdDoc) This method is used to print selected forms.
boolean	refreshGrantsGov(ProposalDevelopmentDocument pdDoc) This method checks for the status of submission for the given ProposalDevelopmentDocument on Grants.gov
protected void	saveGrantsGovStatus(ProposalDevelopmentDocument pdDoc, GetApplicationListResponse applicationListResponse) This method fetches the status from Grants Gov and saves in case status is modified
protected void	saveSubmissionDetails(ProposalDevelopmentDocument pdDoc, S2sAppSubmission appSubmission, SubmitApplicationResponse response, String grantApplicationXml, List<S2sAppAttachments> s2sAppAttachmentList) This method saves the submission details after successful submission of proposal
List<S2sOpportunity>	searchOpportunity(String providerCode, String cfdaNumber, String opportunityId, String competitionId) This method is to find the list of available opportunities for a given cfda number, opportunity ID and competition ID.
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) This method is to set businessObjectService
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService) Sets the dateTimeService attribute value.
protected void	setFormObject(gov.grants.apply.system.metaGrantApplication.GrantApplicationDocument.GrantApplication.Forms forms, org.apache.xmlbeans.XmlObject formObject) This method is to set the formObject to MetaGrants Forms Object.
void	setPrintService(PrintService printService) Sets the printService attribute value.
void	setS2SFormGeneratorService(S2SFormGeneratorService s2SFormGeneratorService) Setter for S2SFormGeneratorService
void	setS2SProposalValidatorService(S2SProposalValidatorService s2SProposalValidatorService) Setter for S2SProposalValidatorService
void	setS2SUtilService(S2SUtilService s2SUtilService) Sets the s2sUtilService attribute value.
void	setS2SValidatorService(S2SValidatorService validatorService) Sets the s2SValidatorService attribute value.
protected void	setValidationErrorMessage(List<org.kuali.rice.kns.util.AuditError> errors) This method is to put validation errors on UI
boolean	submitApplication(ProposalDevelopmentDocument pdDoc) This method is used to submit forms to Grants.gov.
boolean	validateApplication(ProposalDevelopmentDocument proposalDevelopmentDocument) This method is used to validate application before submission.
boolean	validateApplication(ProposalDevelopmentDocument proposalDevelpmentDocument, List<org.kuali.rice.kns.util.AuditError> auditErrors) This method is used to validate application before submission.

Methods inherited from class java.lang.Object

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

Constructor Detail

KRAS2SServiceImpl

public KRAS2SServiceImpl()

Method Detail

getStatusDetails

public String getStatusDetails(String ggTrackingId,
                      String proposalNumber)
                        throws S2SException

This method is used to get the application status details.

Specified by:

getStatusDetails in interface S2SService

Parameters:

ggTrackingId - grants gov tracking id for the application.

proposalNumber - Proposal number.

Throws:

S2SException

See Also:

S2SService.getStatusDetails(java.lang.String, java.lang.String)

parseOpportunityForms

public List<S2sOppForms> parseOpportunityForms(S2sOpportunity opportunity)
                                        throws S2SException

This method returns the list of forms for a given opportunity

Specified by:

parseOpportunityForms in interface S2SService

Parameters:

opportunity -

Returns:

List of S2sOppForms which are included in the given S2sOpportunity

Throws:

S2SException

See Also:

S2SService.parseOpportunityForms(org.kuali.kra.s2s.bo.S2sOpportunity)

refreshGrantsGov

public boolean refreshGrantsGov(ProposalDevelopmentDocument pdDoc)
                         throws S2SException

This method checks for the status of submission for the given ProposalDevelopmentDocument on Grants.gov

Specified by:

refreshGrantsGov in interface S2SService

Parameters:

pdDoc - for which status has to be checked

Returns:

boolean, true if status has changed, false otherwise

Throws:

S2SException

See Also:

S2SService.refreshGrantsGov(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument)

fetchApplicationListResponse

public GetApplicationListResponse fetchApplicationListResponse(ProposalDevelopmentDocument pdDoc)
                                                        throws S2SException

This method fetches the application list from Grants.gov for a given proposal

Specified by:

fetchApplicationListResponse in interface S2SService

Parameters:

pdDoc -

Returns:

GetApplicationListResponse

Throws:

S2SException

saveGrantsGovStatus

protected void saveGrantsGovStatus(ProposalDevelopmentDocument pdDoc,
                       GetApplicationListResponse applicationListResponse)
                            throws S2SException

This method fetches the status from Grants Gov and saves in case status is modified

Parameters:

pdDoc - ProposalDevelopmentDocument

appSubmission - S2sAppSubmission

applicationListResponse - GetApplicationListResponse response from Grants Gov

Throws:

S2SException

checkForSubmissionStatusChange

public boolean checkForSubmissionStatusChange(ProposalDevelopmentDocument pdDoc,
                                     S2sAppSubmission appSubmission)
                                       throws S2SException

This method checks if status on grants.gov has changed since last check and returns the status.

Specified by:

checkForSubmissionStatusChange in interface S2SService

Parameters:

pdDoc -

appSubmission -

Returns:

status

Throws:

S2SException

populateAppSubmission

public void populateAppSubmission(ProposalDevelopmentDocument pdDoc,
                         S2sAppSubmission appSubmission,
                         ApplicationInformationType ggApplication)

This method populates the S2sAppSubmission BO with details from ApplicationInformationType

Specified by:

populateAppSubmission in interface S2SService

Parameters:

appSubmission -

ggApplication -

populateSponsorProposalId

public void populateSponsorProposalId(ProposalDevelopmentDocument pdDoc,
                             S2sAppSubmission appSubmission)

Description copied from interface: S2SService

Takes the appSubmission and proposal and if a federal tracking id has been specified, will set on both the proposal development doc and the related institutional proposal doc if there is not a sponsor proposal id already.

Specified by:

populateSponsorProposalId in interface S2SService

See Also:

S2SService.populateSponsorProposalId(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument, org.kuali.kra.s2s.bo.S2sAppSubmission)

searchOpportunity

public List<S2sOpportunity> searchOpportunity(String providerCode,
                                     String cfdaNumber,
                                     String opportunityId,
                                     String competitionId)
                                       throws S2SException

This method is to find the list of available opportunities for a given cfda number, opportunity ID and competition ID.

Specified by:

searchOpportunity in interface S2SService

Parameters:

cfdaNumber - of the opportunity.

opportunityId - parameter for the opportunity.

competitionId - parameter for the opportunity.

Returns:

List a list containing the available opportunities for the corresponding parameters.

Throws:

S2SException

See Also:

org.kuali.kra.s2s.service.S2SService#searchOpportunity(java.lang.String, java.lang.String, java.lang.String)

submitApplication

public boolean submitApplication(ProposalDevelopmentDocument pdDoc)
                          throws S2SException

This method is used to submit forms to Grants.gov. It generates forms for a given ProposalDevelopmentDocument, validates and then submits the forms

Specified by:

submitApplication in interface S2SService

Parameters:

pdDoc - Proposal Development Document.

Returns:

true if submitted false otherwise.

Throws:

S2SException

See Also:

S2SService.submitApplication(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument)

getGrantApplicationDocument

protected String getGrantApplicationDocument(ProposalDevelopmentDocument pdDoc,
                                 gov.grants.apply.system.metaGrantApplication.GrantApplicationDocument.GrantApplication.Forms forms)
                                      throws S2SException

This method populates values for GrantApplicationDocument for a given ProposalDevelopmentDocument

Parameters:

pdDoc - ProposalDevelopmentDocument

forms - GrantApplicationDocument.GrantApplication.Forms generated XML forms

Returns:

GrantApplicationDocument populated with forms

Throws:

S2SException

saveSubmissionDetails

protected void saveSubmissionDetails(ProposalDevelopmentDocument pdDoc,
                         S2sAppSubmission appSubmission,
                         SubmitApplicationResponse response,
                         String grantApplicationXml,
                         List<S2sAppAttachments> s2sAppAttachmentList)

This method saves the submission details after successful submission of proposal

Parameters:

pdDoc - ProposalDevelopmentDocument that was submitted

appSubmission - S2sAppSubmission submission details of proposal

response - SubmitApplicationResponse submission response from grants gov

grantApplicationXml - String XML content of submission

s2sAppAttachmentList - S2sAppAttachments attachments included in submission

validateApplication

public boolean validateApplication(ProposalDevelopmentDocument proposalDevelopmentDocument)
                            throws S2SException

This method is used to validate application before submission.

Specified by:

validateApplication in interface S2SService

Parameters:

proposalDevelopmentDocument - Proposal Development Document.

Returns:

boolean true if valid false otherwise.

Throws:

S2SException

See Also:

S2SService.validateApplication(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument)

validateApplication

public boolean validateApplication(ProposalDevelopmentDocument proposalDevelpmentDocument,
                          List<org.kuali.rice.kns.util.AuditError> auditErrors)
                            throws S2SException

Description copied from interface: S2SService

This method is used to validate application before submission.

Specified by:

validateApplication in interface S2SService

Parameters:

proposalDevelpmentDocument - Proposal Development Document.

Returns:

boolean true if valid false otherwise.

Throws:

S2SException

generateAndValidateForms

protected boolean generateAndValidateForms(gov.grants.apply.system.metaGrantApplication.GrantApplicationDocument.GrantApplication.Forms forms,
                               List<AttachmentData> attList,
                               ProposalDevelopmentDocument pdDoc)
                                    throws S2SException

Throws:

S2SException

generateAndValidateForms

protected boolean generateAndValidateForms(gov.grants.apply.system.metaGrantApplication.GrantApplicationDocument.GrantApplication.Forms forms,
                               List<AttachmentData> attList,
                               ProposalDevelopmentDocument pdDoc,
                               List<org.kuali.rice.kns.util.AuditError> auditErrors)
                                    throws S2SException

This method is to generate and validate the generated forms.

Parameters:

forms - Forms

attList - List of attachments.

pdDoc - Proposal Development Document.

Returns:

validation result true if valid false otherwise.

Throws:

S2SException

setFormObject

protected void setFormObject(gov.grants.apply.system.metaGrantApplication.GrantApplicationDocument.GrantApplication.Forms forms,
                 org.apache.xmlbeans.XmlObject formObject)

This method is to set the formObject to MetaGrants Forms Object. The xmlbeans Schema compiled with xsd:any does not provide a direct method to add individual forms to the Forms object. In this method, an XML Cursor is created from the existing Forms object and use the moveXml method to add the form object to the Forms object.

Parameters:

forms - Forms object to which the grants.gov form is added.

formObject - xml object representing the grants.gov form.

setValidationErrorMessage

protected void setValidationErrorMessage(List<org.kuali.rice.kns.util.AuditError> errors)

This method is to put validation errors on UI

Parameters:

errors - List of validation errors which has to be displayed on UI.

convertToArrayList

protected ArrayList<S2sOpportunity> convertToArrayList(String source,
                                           GetOpportunityListResponse resList)

This method convert GetOpportunityListResponse to ArrayList

Parameters:

resList - {GetOpportunityListResponse}

Returns:

ArrayList containing all form information

convert2S2sOpportunity

protected S2sOpportunity convert2S2sOpportunity(String providerCode,
                                    OpportunityInformationType oppInfoType)

This method convert OpportunityInformationType to OpportunityInfo

Parameters:

oppInfoType - {OpportunityInformationType}

Returns:

OpportunityInfo containing Opportunity information corresponding to the OpportunityInformationType object.

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

This method is to set businessObjectService

Parameters:

businessObjectService(BusinessObjectService) -

setS2SFormGeneratorService

public void setS2SFormGeneratorService(S2SFormGeneratorService s2SFormGeneratorService)

Setter for S2SFormGeneratorService

Parameters:

s2SFormGeneratorService -

setS2SProposalValidatorService

public void setS2SProposalValidatorService(S2SProposalValidatorService s2SProposalValidatorService)

Setter for S2SProposalValidatorService

Parameters:

s2SProposalValidatorService -

setS2SUtilService

public void setS2SUtilService(S2SUtilService s2SUtilService)

Sets the s2sUtilService attribute value.

Parameters:

generatorUtilService - The s2sUtilService to set.

printForm

public AttachmentDataSource printForm(ProposalDevelopmentDocument pdDoc)
                               throws S2SException,
                                      PrintingException

This method is used to print selected forms.

Specified by:

printForm in interface S2SService

Parameters:

pdDoc - Proposal Development Document.

Returns:

AttachmentDataSource for the selected form.

Throws:

S2SException

PrintingException

getPrintService

public PrintService getPrintService()

Gets the printService attribute.

Returns:

Returns the printService.

setPrintService

public void setPrintService(PrintService printService)

Sets the printService attribute value.

Parameters:

printService - The printService to set.

getS2SFormGeneratorService

public S2SFormGeneratorService getS2SFormGeneratorService()

Gets the s2SFormGeneratorService attribute.

Returns:

Returns the s2SFormGeneratorService.

getS2SProposalValidatorService

public S2SProposalValidatorService getS2SProposalValidatorService()

Gets the s2SProposalValidatorService attribute.

Returns:

Returns the s2SProposalValidatorService.

getS2sUtilService

public S2SUtilService getS2sUtilService()

Gets the s2sUtilService attribute.

Returns:

Returns the s2sUtilService.

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

Gets the businessObjectService attribute.

Returns:

Returns the businessObjectService.

getDateTimeService

public org.kuali.rice.core.api.datetime.DateTimeService getDateTimeService()

Gets the dateTimeService attribute.

Returns:

Returns the dateTimeService.

setDateTimeService

public void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)

Sets the dateTimeService attribute value.

Parameters:

dateTimeService - The dateTimeService to set.

getS2SValidatorService

public S2SValidatorService getS2SValidatorService()

Gets the s2SValidatorService attribute.

Returns:

Returns the s2SValidatorService.

setS2SValidatorService

public void setS2SValidatorService(S2SValidatorService validatorService)

Sets the s2SValidatorService attribute value.

Parameters:

validatorService - The s2SValidatorService to set.

getS2sConnectorService

protected S2SConnectorService getS2sConnectorService(S2sOpportunity s2sOpportunity)