@SchemaValidation(handler=eu.europa.ec.sfc2014.frontoffice.jws.SchemaValidationErrorHandler.class) public class MajorProjectSubmissionServiceImpl extends MajorProjectsJwsImpl<eu.europa.ec.sfc2014.frontoffice.model.domain.majorproject.submission.MajorProjectSubmissionVersion,SfcMajorProjectSubmissionVersionDTO,eu.europa.ec.sfc2014.frontoffice.model.dto.majorproject.MajorProjectSubmissionListContainer>
The following Action/State diagram describe the complete internal business flow:
The Web Service is defined as a "document-literal" service, which means that the SOAP messages have a single part referencing an XML Schema element that defines the entire body.
Constructor and Description |
---|
MajorProjectSubmissionServiceImpl() |
Modifier and Type | Method and Description |
---|---|
SfcMajorProjectSubmissionVersionDTO |
create(SfcCciDTO cci,
java.lang.Integer financialYear)
To be used when a user wants to create a new Major Project.
|
SfcMajorProjectSubmissionVersionDTO |
createNewVersion(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to create a new version of Major Project Submission.
|
void |
delete(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to delete a Major Project Submission version from the system.
|
SfcMajorProjectSubmissionVersionDTO |
partialSave(SfcMajorProjectSubmissionVersionDTO version) |
SfcMajorProjectSubmissionVersionDTO |
read(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
Returns a single Major Project for the given CCI and for the given version/workVersion.
|
SfcTableOfContentDTO |
readTableOfContent(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion,
java.lang.String locale) |
void |
resubmit(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion,
java.lang.String resubmitUnderArticle)
To be used when a user wants to withdraw a Major Project Submission Version and stop the procedure.
|
void |
returnForModification(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion,
java.lang.String reason)
To be used when a user wants to return the major Project Submission version sent by the Member State/Region because it is incomplete
or incorrect and needs to be modified.
|
SfcMajorProjectSubmissionVersionDTO |
save(SfcMajorProjectSubmissionVersionDTO version)
Saves a Major Project Submission version.
|
SfcSearchResultDTO<SfcMajorProjectSubmissionVersionDTO> |
search(SfcMajorProjectQueryDTO query)
Searches for Major Project based on the given Criteria
The following example sort ascending based on cci and full version and returns the first 100 final results with CCI pattern 2014BE%
|
void |
send(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user is ready to send its recorded data on a Major Project Submission version to the Commission or to an upper Node.
|
java.util.List<SfcValidationResultsDTO> |
validate(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion,
java.lang.String locale)
To be used to do an overall validation of the information related to a version of major projects submission.
|
void |
withdraw(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to withdraw a Major Project Submission Version and stop the procedure.
|
readMajorProjectTableOfContent, searchMajorProject
public SfcMajorProjectSubmissionVersionDTO read(SfcCciDTO cci, java.lang.Integer version, java.lang.Integer workVersion) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
This method returns the (last)Major Project Submission object when found. In case nothing could be found in the SFC2014 database (or the user doesn't have the right permission) an empty response is returned.
cci
- The mandatory cciversion
- The version number. Can be null
.workVersion
- The workVersion. Can be null
.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
- in case of errorpublic SfcTableOfContentDTO readTableOfContent(SfcCciDTO cci, java.lang.Integer version, java.lang.Integer workVersion, java.lang.String locale) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- The mandatory cci for this Major Project.version
- The version number of the Major Project. Can be null
.workVersion
- The workVersion of the Major Project. Can be null
.locale
- The language of the Contents. Can be null
.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcSearchResultDTO<SfcMajorProjectSubmissionVersionDTO> search(SfcMajorProjectQueryDTO query) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
<com:query>
<!--Optional:-->
<resultRange>
<startIndex>0</startIndex>
<endIndex>99</endIndex>
</resultRange>
<!--Zero or more repetitions:-->
<sort>CCI</sort>
<sort>VERSION</sort>
<!--Zero or more repetitions:-->
<asc>true</asc>
<asc>true</asc>
<!--Optional:-->
<criteria>
<!--Optional:-->
<cci>2014BE</cci>
</criteria>
</com:query>
query
- SfcMajorProjectQueryDTOeu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcMajorProjectSubmissionVersionDTO save(SfcMajorProjectSubmissionVersionDTO version) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
The saving of a major project submission version is not an official send. It just saves the data into the database. Then, once saved, the version can be validated, in order to check that it fulfills the business rules, and at last, once validated, it can be officially sent to the Commission.
The version may require several add-ons of non structured documents in order to be valid. These documents are not uploaded through this service, but through the DocumentService. The DocumentService may be involved between the creation and the validation phase.
The version argument must always be provided if not an SfcFaultException will be thrown.
version
- The major project version to save.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcMajorProjectSubmissionVersionDTO partialSave(SfcMajorProjectSubmissionVersionDTO version) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcMajorProjectSubmissionVersionDTO createNewVersion(SfcCciDTO cci, java.lang.Integer version, java.lang.Integer workVersion) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
On success, a new version of the Major Project Submission has been created as a copy of the previous version, with a version number identical to the previous and a working version number incremented by one. Its status was set to 'Open'.
cci
- the cciversion
- the versionworkVersion
- the work versioneu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcMajorProjectSubmissionVersionDTO create(SfcCciDTO cci, java.lang.Integer financialYear) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
The Operational Programme is adopted and managed on the user's node.
When editing a version of a Major Project, its status is 'Open', 'Ready to send' or 'Sent' at the level of the Member State and currently resides on the user's node.
cci
- financialYear
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public java.util.List<SfcValidationResultsDTO> validate(SfcCciDTO cci, java.lang.Integer version, java.lang.Integer workVersion, java.lang.String locale) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- version
- workVersion
- locale
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public void send(SfcCciDTO cci, java.lang.Integer version, java.lang.Integer workVersion) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- version
- workVersion
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public void returnForModification(SfcCciDTO cci, java.lang.Integer version, java.lang.Integer workVersion, java.lang.String reason) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- version
- workVersion
- reason
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public void delete(SfcCciDTO cci, java.lang.Integer version, java.lang.Integer workVersion) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- version
- workVersion
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public void withdraw(SfcCciDTO cci, java.lang.Integer version, java.lang.Integer workVersion) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- version
- workVersion
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public void resubmit(SfcCciDTO cci, java.lang.Integer version, java.lang.Integer workVersion, java.lang.String resubmitUnderArticle) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- version
- workVersion
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
Copyright © 2024. All rights reserved.