@SchemaValidation(handler=eu.europa.ec.sfc2014.frontoffice.jws.SchemaValidationErrorHandler.class) public class AccountsIpaCbcServiceImpl extends AccountsServiceImpl<SfcAccountsVersionIpaCbcDTO,eu.europa.ec.sfc2014.frontoffice.model.domain.accounts.sfcfemfffead.AccountsVersionIpaCbc,eu.europa.ec.sfc2014.frontoffice.model.domain.programme.ipacbc.ProgrammeIpaCbc,eu.europa.ec.sfc2014.frontoffice.jws.service.conversion.execution.accounts.ipacbc.AccountsIpaCbcConverter>
The following Action/State diagram describe the complete internal business flow of a Accounts:
These are the main methods:
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 |
---|
AccountsIpaCbcServiceImpl() |
Modifier and Type | Method and Description |
---|---|
void |
agreeWithEC(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to agree with EC Proposal for an Accounts version
|
SfcAccountsVersionIpaCbcDTO |
create(SfcCciDTO cci,
java.lang.Integer financialYear)
To be used when a user wants to create a new Account.
|
SfcAccountsVersionIpaCbcDTO |
createNewVersion(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to create a new version of Accounts AMF/ISF.
|
void |
delete(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to delete a Accounts version from the system.
|
void |
disagreeWithEC(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to disagreeWithEC with EC Proposal for an Accounts version
|
SfcAccountsVersionIpaCbcDTO |
partialSave(SfcAccountsVersionIpaCbcDTO version) |
SfcAccountsVersionIpaCbcDTO |
read(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
Returns a single Account IpaCbc 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 Accounts version sent by the Member State/Region because it is incomplete or incorrect and needs to be modified.
|
SfcAccountsVersionIpaCbcDTO |
save(SfcAccountsVersionIpaCbcDTO version)
Saves a Accounts Version version.
|
SfcSearchResultDTO<SfcAccountsVersionIpaCbcDTO> |
search(SfcAccountsQueryDTO query)
Searches for IpaCbc Accounts 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 Accounts version to the Commission or to an upper Node.
|
void |
signAccounts(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
This use case occurs when a user wants to sign the Accounts Certificate of the Accounts version.
|
void |
signAuditOpinon(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
This use case occurs when a user wants to sign the Audit Opinion of the Accounts version.
|
void |
signManagementDeclaration(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
This use case occurs when a user wants to sign the Management Declaration of the Accounts version.
|
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 Accounts.
|
fillAppendix8FromPap
public SfcAccountsVersionIpaCbcDTO 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)Account 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. Example Call :
<cci>
<year>2014</year>
<targetArea>BE</targetArea>
<leadDg>65</leadDg>
<budgetSource>AM</budgetSource>
<objectSubType>NP</objectSubType>
<sequence>002</sequence>
</cci>
cci
- The mandatory cci for this Account.version
- The version number of the Account. Can be null
.workVersion
- The workVersion of the Account. 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 Accountversion
- The version number of the Account. Can be null
.workVersion
- The workVersion of the Account. Can be null
.locale
- The language of the Contents. Can be null
.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcSearchResultDTO<SfcAccountsVersionIpaCbcDTO> search(SfcAccountsQueryDTO 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>
</criteria>
</query>
query
- SfcAccountsQueryDTOeu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcAccountsVersionIpaCbcDTO save(SfcAccountsVersionIpaCbcDTO 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 SfcAccountsVersionIpaCbcDTO partialSave(SfcAccountsVersionIpaCbcDTO version) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcAccountsVersionIpaCbcDTO 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 Accounts 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 SfcAccountsVersionIpaCbcDTO 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, 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 Accounts, 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 signAccounts(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 signManagementDeclaration(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 signAuditOpinon(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 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 agreeWithEC(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 disagreeWithEC(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.