@SchemaValidation(handler=eu.europa.ec.sfc2014.frontoffice.jws.SchemaValidationErrorHandler.class) public class PaymentForecastEmffServiceImpl extends PaymentForecastJwsImpl<eu.europa.ec.sfc2014.frontoffice.model.domain.paymentforecast.PaymentForecastVersionEmff,SfcPaymentForecastVersionEmffDTO>
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 |
---|
PaymentForecastEmffServiceImpl() |
Modifier and Type | Method and Description |
---|---|
SfcPaymentForecastVersionEmffDTO |
create(SfcCciDTO cci,
java.lang.Integer financialDataVersion)
To be used when a user wants to create a new Payment Forecast.
|
SfcPaymentForecastVersionEmffDTO |
createNewVersion(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to create a new version of Payment Forecast Emff.
|
void |
delete(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to delete a Payment Forecast version from the system.
|
SfcPaymentForecastVersionEmffDTO |
partialSave(SfcPaymentForecastVersionEmffDTO version) |
SfcPaymentForecastVersionEmffDTO |
read(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
Returns a single Payment Forecast Emff 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 Payment Forecast version sent by the Member State/Region because
it is incomplete or incorrect and needs to be modified.
|
SfcPaymentForecastVersionEmffDTO |
save(SfcPaymentForecastVersionEmffDTO version)
Saves a Payment Forecast Version version.
|
SfcSearchResultDTO<SfcPaymentForecastVersionEmffDTO> |
search(SfcPaymentForecastQueryDTO query)
Searches for EMFF Payment Forecast based on the given Criteria
|
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 Payment Forecast 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 Payment Forecast.
|
public SfcPaymentForecastVersionEmffDTO 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)Payment Forecast 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>
<year>2014</year>
<targetArea>BE</targetArea>
<leadDg>14</leadDg>
<budgetSource>MF</budgetSource>
<objectSubType>OP</objectSubType>
<sequence>013</sequence>
</cci>
<!--Optional:-->
<version>1402</version>
<!--Optional:-->
<workVersion>0</workVersion>
cci
- The mandatory cci for this Payment Forecastversion
- The version number of the Payment Forecast. Can be null
.workVersion
- The workVersion of the Payment Forecast. 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 PaymentForecastversion
- The version number of the PaymentForecast. Can be null
.workVersion
- The workVersion of the PaymentForecast. Can be null
.locale
- The language of the Contents. Can be null
.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcSearchResultDTO<SfcPaymentForecastVersionEmffDTO> search(SfcPaymentForecastQueryDTO 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>2014BE</cci>
<isFinal>true</isFinal>
</criteria>
</query>
query
- SfcPaymentForecastQueryDTOeu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcPaymentForecastVersionEmffDTO save(SfcPaymentForecastVersionEmffDTO version) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
The version argument must always be provided if not an SfcFaultException will be thrown.
version
- The payment forecast to save.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcPaymentForecastVersionEmffDTO partialSave(SfcPaymentForecastVersionEmffDTO version) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcPaymentForecastVersionEmffDTO 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 Payment Forecast 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 SfcPaymentForecastVersionEmffDTO create(SfcCciDTO cci, java.lang.Integer financialDataVersion) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- of the programmefinancialDataVersion
- of the payment forecasteu.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.