@SchemaValidation(handler=eu.europa.ec.sfc2014.frontoffice.jws.SchemaValidationErrorHandler.class)
public class PartnershipAgreementServiceImpl
extends java.lang.Object
The Partnership agreement service is formed by this distinct web service:
All these web services have the same operations and they share some types.
The cci example :
<cci>
<year>2014</year>
<targetArea>BE</targetArea>
<leadDg>16</leadDg>
<budgetSource>M8</budgetSource>
<objectSubType>PA</objectSubType>
<sequence>002</sequence>
</cci>
The query example for searchPartnershipAgreement
The following example will return the first 100 results with CCI pattern %m8% sorted based on modification date
<com:query>
<!--Optional:-->
<resultRange>
<endIndex>0</endIndex>
<startIndex>99</startIndex>
</resultRange>
<!--Zero or more repetitions:-->
<sort>MODIFICATION_DATE</sort>
<sort>CCI</sort>
<!--Zero or more repetitions:-->
<asc>true</asc>
<asc>true</asc>
<!--Optional:-->
<criteria>
<!--Optional:-->
<cci>M8</cci>
</criteria>
</com:query>
The following Action/State diagram describe the complete internal business flow of a Partnership agreement:
Constructor and Description |
---|
PartnershipAgreementServiceImpl() |
Modifier and Type | Method and Description |
---|---|
SfcPartnershipAgreementVersionDTO |
read(SfcCciDTO cci,
java.lang.Short version,
java.lang.Short workVersion)
Returns a single Partnership Agreement for the given CCI and for the given version/workVersion.
|
SfcTableOfContentDTO |
readTableOfContent(SfcCciDTO cci,
java.lang.Short version,
java.lang.Short workVersion,
java.lang.String locale)
Example Call :
|
SfcSearchResultDTO<SfcPartnershipAgreementVersionDTO> |
search(SfcProgrammesQueryDTO query)
Searches for Partnership Agreements 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%
|
public SfcPartnershipAgreementVersionDTO read(SfcCciDTO cci, java.lang.Short version, java.lang.Short workVersion) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
This method returns the (last) Partnership Agreement 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 :
<read>
<cci>
<year>2014</year>
<targetArea>BE</targetArea>
<leadDg>16</leadDg>
<budgetSource>M8</budgetSource>
<objectSubType>PA</objectSubType>
<sequence>002</sequence>
</cci>
</read>
cci
- The mandatory cci for this Payment Application.version
- The version number of the Partnership Agreement. Can be null
.workVersion
- The workVersion of the Partnership Agreement. Can be null
.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
- in case of errorpublic SfcTableOfContentDTO readTableOfContent(SfcCciDTO cci, java.lang.Short version, java.lang.Short workVersion, java.lang.String locale) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
<readTableOfContent>
<cci>
<year>2014</year>
<targetArea>BE</targetArea>
<leadDg>16</leadDg>
<budgetSource>M8</budgetSource>
<objectSubType>PA</objectSubType>
<sequence>002</sequence>
</cci>
</readTableOfContent>
cci
- The mandatory cci for this Partnership Agreementversion
- The version number of the Partnership Agreement. Can be null
.workVersion
- The workVersion of the Partnership Agreement. Can be null
.locale
- The language of the Contents. Can be null
.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
- in case of errorpublic SfcSearchResultDTO<SfcPartnershipAgreementVersionDTO> search(SfcProgrammesQueryDTO 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
- SfcProgrammesQueryDTOeu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
Copyright © 2024. All rights reserved.