@SchemaValidation(handler=eu.europa.ec.sfc2014.frontoffice.jws.SchemaValidationErrorHandler.class) public class ImplementationReportAmfIsfServiceImpl extends ImplementationReportJwsImpl<SfcImplementationReportVersionAmfIsfDTO,eu.europa.ec.sfc2014.frontoffice.model.domain.implementationreport.amfisf.ImplementationReportVersionAmfIsf,eu.europa.ec.sfc2014.frontoffice.jws.service.conversion.monitoring.implementationreport.amfisf.ImplementationReportAmfIsfConverter>
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 |
---|
ImplementationReportAmfIsfServiceImpl() |
Modifier and Type | Method and Description |
---|---|
SfcImplementationReportVersionAmfIsfDTO |
create(SfcCciDTO cci,
java.lang.Integer financialYear)
To be used when a user wants to create a new Implementation Report.
|
SfcImplementationReportVersionAmfIsfDTO |
createNewVersion(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to create a new version of Implementation Report AMF/ISF.
|
void |
delete(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to delete a Implementation Report version from the system.
|
SfcImplementationReportVersionAmfIsfDTO |
partialSave(SfcImplementationReportVersionAmfIsfDTO version) |
SfcImplementationReportVersionAmfIsfDTO |
read(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
Returns a single Implementation Report version 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 |
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 Implementation Report version sent by the Member State/Region because it is incomplete or incorrect and needs to be modified.
|
SfcImplementationReportVersionAmfIsfDTO |
save(SfcImplementationReportVersionAmfIsfDTO version)
Saves a Implementation Report Version version.
|
SfcSearchResultDTO<SfcImplementationReportVersionAmfIsfDTO> |
search(SfcImplementationReportQueryDTO query)
Search is equivalent to the UI search of the implementation report
<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>2014</cci>
<fund>ISF</fund>
</criteria>
</query>
|
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 Implementation Report 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 the Implementation Report.
|
public ImplementationReportAmfIsfServiceImpl()
public SfcImplementationReportVersionAmfIsfDTO 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)ImplementationReportVersion 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.
<read>
<cci>
<year>2014</year>
<targetArea>BE</targetArea>
<leadDg>05</leadDg>
<budgetSource>MA</budgetSource>
<objectSubType>OP</objectSubType>
<sequence>002</sequence>
</cci>
</read>
cci
- The mandatory cci for this ImplementationReportVersion.version
- The version number of the ImplementationReportVersion. Can be null
.workVersion
- The workVersion of the ImplementationReportVersion. 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 Implementation Reportversion
- The version number of the Implementation Report. Can be null
.workVersion
- The workVersion of the Implementation Report. Can be null
.locale
- The language of the Contents. Can be null
.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcSearchResultDTO<SfcImplementationReportVersionAmfIsfDTO> search(SfcImplementationReportQueryDTO query) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
<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>2014</cci>
<fund>ISF</fund>
</criteria>
</query>
query
- SfcImplementationReportQueryDTOeu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcImplementationReportVersionAmfIsfDTO save(SfcImplementationReportVersionAmfIsfDTO version) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
The saving of a accounts 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 fulfils 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 accounts to save.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcImplementationReportVersionAmfIsfDTO partialSave(SfcImplementationReportVersionAmfIsfDTO version) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcImplementationReportVersionAmfIsfDTO 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 Implementation Report 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 SfcImplementationReportVersionAmfIsfDTO 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. Maximum one version for the same CCI, *
When editing a version of a Implementation Report, 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
Copyright © 2024. All rights reserved.