org.kuali.kra.s2s.service

Interface S2SService

All Known Implementing Classes:

KRAS2SServiceImpl

public interface S2SService

This class is called for various S2S services such as validate application, Submit application,Print selected forms, search opportunities,Status Details.

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.
GetApplicationListResponse	fetchApplicationListResponse(ProposalDevelopmentDocument pdDoc) This method fetches the application list from Grants.gov for a given proposal
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
List<S2sOpportunity>	searchOpportunity(String providerCode, String cfdaNumber, String opportunityId, String competitionId) This method is to find the list of available opportunities
boolean	submitApplication(ProposalDevelopmentDocument pdDoc) This method is used to submit forms to the grants.guv
boolean	validateApplication(ProposalDevelopmentDocument pdDoc) This method is used to validate application before submission.
boolean	validateApplication(ProposalDevelopmentDocument pdDoc, List<org.kuali.rice.kns.util.AuditError> auditErrors) This method is used to validate application before submission.

Method Detail

searchOpportunity

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

This method is to find the list of available opportunities

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

parseOpportunityForms

List<S2sOppForms> parseOpportunityForms(S2sOpportunity opportunity)
                                        throws S2SException

This method returns the list of forms for a given opportunity

Parameters:

opportunity -

Returns:

Listof S2sOppForms which are included in the given S2sOpportunity

Throws:

S2SException

refreshGrantsGov

boolean refreshGrantsGov(ProposalDevelopmentDocument pdDoc)
                         throws S2SException

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

Parameters:

pdDoc - for which status has to be checked

Returns:

boolean, true if status has changed, false otherwise

Throws:

S2SException

getStatusDetails

String getStatusDetails(String ggTrackingId,
                      String proposalNumber)
                        throws S2SException

This method is used to get the application status details.

Parameters:

ggTrackingId - grants gov tracking id for the application.

proposalNumber - Proposal number.

Throws:

S2SException

printForm

AttachmentDataSource printForm(ProposalDevelopmentDocument pdDoc)
                               throws S2SException,
                                      PrintingException

This method is used to print selected forms.

Parameters:

pdDoc - Proposal Development Document.

Returns:

AttachmentDataSource for the selected form.

Throws:

S2SException

PrintingException

submitApplication

boolean submitApplication(ProposalDevelopmentDocument pdDoc)
                          throws S2SException

This method is used to submit forms to the grants.guv

Parameters:

pdDoc - Proposal Development Document.

Returns:

true if submitted false otherwise.

Throws:

S2SException

validateApplication

boolean validateApplication(ProposalDevelopmentDocument pdDoc)
                            throws S2SException

This method is used to validate application before submission.

Parameters:

pdDoc - Proposal Development Document.

Returns:

boolean true if valid false otherwise.

Throws:

S2SException

validateApplication

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

This method is used to validate application before submission.

Parameters:

pdDoc - Proposal Development Document.

Returns:

boolean true if valid false otherwise.

Throws:

S2SException

populateAppSubmission

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

This method populates the S2sAppSubmission BO with details from ApplicationInformationType

Parameters:

appSubmission -

ggApplication -

populateSponsorProposalId

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.

Parameters:

pdDoc -

appSubmission -

fetchApplicationListResponse

GetApplicationListResponse fetchApplicationListResponse(ProposalDevelopmentDocument pdDoc)
                                                        throws S2SException

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

Parameters:

pdDoc -

Returns:

GetApplicationListResponse

Throws:

S2SException

checkForSubmissionStatusChange

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.

Parameters:

pdDoc -

appSubmission -

Returns:

status

Throws:

S2SException