@SchemaValidation(handler=eu.europa.ec.sfc2014.frontoffice.jws.SchemaValidationErrorHandler.class) public class PaymentApplicationIpaCBServiceImpl extends PaymentApplicationJwsImpl<eu.europa.ec.sfc2014.frontoffice.model.domain.paymentapplication.PaymentApplicationVersionIpaCbc,eu.europa.ec.sfc2014.directory.model.domain.AccountingPeriodSfCfEmff,SfcPaymentApplicationVersionIpaCBDTO>
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 |
---|
PaymentApplicationIpaCBServiceImpl() |
Modifier and Type | Method and Description |
---|---|
void |
cancel(SfcCciDTO cci,
java.lang.String period,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to cancel an Interim Payment Application version
with documents sent to the Commission or
with a previous version Returned for Modification by the Commission, before it reaches an Acceptance or Fully Rejection by the Commission.
|
SfcPaymentApplicationVersionIpaCBDTO |
create(SfcCciDTO cci,
java.lang.Boolean isFinal,
java.lang.String period,
java.lang.String nationalReference)
To be used when a user wants to create a new Payment Application.
|
SfcPaymentApplicationVersionIpaCBDTO |
createNewVersion(SfcCciDTO cci,
java.lang.String period,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to create a new version of a Payment Application.
|
void |
delete(SfcCciDTO cci,
java.lang.String period,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to delete a Payment Application version from the system.
|
SfcPaymentApplicationVersionIpaCBDTO |
partialSave(SfcPaymentApplicationVersionIpaCBDTO version)
Similar to the save operation this partialSave will only update the data that has been provided.
|
SfcPaymentApplicationVersionIpaCBDTO |
read(SfcCciDTO cci,
java.lang.String period,
java.lang.Integer version,
java.lang.Integer workVersion)
Returns a single Payment Application IPA CB for the given CCI and for the given version/workVersion.
|
SfcTableOfContentDTO |
readTableOfContent(SfcCciDTO cci,
java.lang.String period,
java.lang.Integer version,
java.lang.Integer workVersion,
java.lang.String locale) |
void |
returnForModification(SfcCciDTO cci,
java.lang.String period,
java.lang.Integer version,
java.lang.Integer workVersion,
java.lang.String reason)
To be used when a user wants to return the Payment Application version sent by the Member State/Region because it is incomplete or incorrect and needs to be modified.
|
SfcPaymentApplicationVersionIpaCBDTO |
save(SfcPaymentApplicationVersionIpaCBDTO version)
Saves a PaymentApplicationIpaCB version.
|
SfcSearchResultDTO<SfcPaymentApplicationVersionIpaCBDTO> |
search(SfcPaymentApplicationQueryDTO query)
Searches for IgjEtc Payment Applications 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.String period,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user is ready to send its recorded data on a Payment Application version to the Commission or to an upper Node.
|
java.util.List<SfcValidationResultsDTO> |
validate(SfcCciDTO cci,
java.lang.String period,
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 Application.
|
public SfcPaymentApplicationVersionIpaCBDTO read(SfcCciDTO cci, java.lang.String period, java.lang.Integer version, java.lang.Integer workVersion) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
This method returns the (last)Payment Application 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>TC</targetArea>
<leadDg>16</leadDg>
<budgetSource>I5</budgetSource>
<objectSubType>CB</objectSubType>
<sequence>008</sequence>
</cci>
<period>2015</period>
<fund>IPAE</fund>
<!--Optional:-->
<version>2</version>
<!--Optional:-->
<workVersion>01</workVersion>
cci
- The mandatory cci for this Payment Application.period
- The mandatory accounting period for this Payment Application.fund
- The mandatory fund code for this Payment Application.version
- The version number of the Payment Application. Can be null
.workVersion
- The workVersion of the Payment Application. Can be null
.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
- in case of errorpublic SfcTableOfContentDTO readTableOfContent(SfcCciDTO cci, java.lang.String period, 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 Payment Applicationperiod
- The mandatory accounting period for this Payment Application.fund
- The mandatory fund code for this Payment Application.version
- The version number of the Payment Application. Can be null
.workVersion
- The workVersion of the Payment Application. Can be null
.locale
- The language of the Contents. Can be null
.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcSearchResultDTO<SfcPaymentApplicationVersionIpaCBDTO> search(SfcPaymentApplicationQueryDTO 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
- SfcPaymentApplicationQueryDTOeu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcPaymentApplicationVersionIpaCBDTO save(SfcPaymentApplicationVersionIpaCBDTO version) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
The saving of a payment application version is not an official send. It just saves the data into the database. Then, once saved, the payment application 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 payment application 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 of the payment application.
The version argument must always be provided if not an SfcFaultException will be thrown.
version
- The payment application to save.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcPaymentApplicationVersionIpaCBDTO partialSave(SfcPaymentApplicationVersionIpaCBDTO version) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
version
- The payment application to save.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcPaymentApplicationVersionIpaCBDTO createNewVersion(SfcCciDTO cci, java.lang.String period, 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 Application 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 cciperiod
- the accounting period codeversion
- the versionworkVersion
- the work versioneu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcPaymentApplicationVersionIpaCBDTO create(SfcCciDTO cci, java.lang.Boolean isFinal, java.lang.String period, java.lang.String nationalReference) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
When creating a new Interim Payment Application, all existing versions (last working version) for the same CCI and Fund must be 'Sent' to the Commission, 'Cancelled', 'Fully Rejected by EC' or 'Accepted by EC'.
When creating a new Final Payment Application, all existing versions (last working version) for the same CCI and Fund must be 'Cancelled' or 'Fully Rejected by EC' or 'Accepted by EC'.
The Operational Programme is adopted and managed on the user's node. Maximum one version for the same CCI, Fund and Accounting Period per day can be created (In this case it is possible to make a Final Payment for Year N-1 and an Interim Payment for Year N the same day).
When editing a version of a Payment Application, 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
- isFinal
- period
- nationalReference
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public java.util.List<SfcValidationResultsDTO> validate(SfcCciDTO cci, java.lang.String period, java.lang.Integer version, java.lang.Integer workVersion, java.lang.String locale) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- period
- version
- workVersion
- locale
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public void send(SfcCciDTO cci, java.lang.String period, java.lang.Integer version, java.lang.Integer workVersion) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- period
- version
- workVersion
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public void returnForModification(SfcCciDTO cci, java.lang.String period, java.lang.Integer version, java.lang.Integer workVersion, java.lang.String reason) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- period
- version
- workVersion
- reason
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public void delete(SfcCciDTO cci, java.lang.String period, java.lang.Integer version, java.lang.Integer workVersion) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- period
- version
- workVersion
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public void cancel(SfcCciDTO cci, java.lang.String period, java.lang.Integer version, java.lang.Integer workVersion) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- period
- version
- workVersion
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
Copyright © 2024. All rights reserved.