@SchemaValidation(handler=eu.europa.ec.sfc2014.frontoffice.jws.SchemaValidationErrorHandler.class) public class CooperationProgrammeEtcServiceImpl extends ProgrammeVersionJwsImpl<SfcProgrammeVersionEtcDTO,eu.europa.ec.sfc2014.frontoffice.model.domain.programme.sfcf.ProgrammeVersionSfCf>
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 |
---|
CooperationProgrammeEtcServiceImpl() |
Modifier and Type | Method and Description |
---|---|
void |
cancel(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to cancel a co-operational programme version.
|
SfcProgrammeVersionEtcDTO |
create(SfcCciDTO cci,
java.lang.String title,
java.lang.Short firstYear,
java.lang.Short lastYear,
java.lang.String comments)
To be used when a user wants to create a new programme version ETC.
|
SfcProgrammeVersionEtcDTO |
createNewVersion(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to create a new version of an co-operational programme.
|
void |
delete(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to delete a co-operational programme version from the system.
|
SfcProgrammeVersionEtcDTO |
partialSave(SfcProgrammeVersionEtcDTO version) |
SfcProgrammeVersionEtcDTO |
read(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
Returns a single Co-operational Programme 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 Operational programme version sent by the Member State/Region
because it is incomplete or incorrect and needs to be modified.
|
void |
save(SfcProgrammeVersionEtcDTO version)
Saves a new Co-operational Programme version.
|
SfcSearchResultDTO<SfcProgrammeVersionEtcDTO> |
search(SfcProgrammesQueryDTO query)
Search is equivalent to the UI search of the programme.
|
void |
send(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
Send programme version.
|
java.util.List<SfcValidationResultsDTO> |
validate(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion,
java.lang.String locale)
Validates programme version.
|
public SfcProgrammeVersionEtcDTO 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)ProgrammeVersion 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>M6</budgetSource>
<objectSubType>TN</objectSubType>
<sequence>002</sequence>
</cci>
cci
- The mandatory cci for this ProgrammeVersion.version
- The version number of the ProgrammeVersion. Can be null
.workVersion
- The workVersion of the ProgrammeVersion. 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 Programmeversion
- The version number of the Programme. Can be null
.workVersion
- The workVersion of the Programme. Can be null
.locale
- The language of the Contents. Can be null
.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcProgrammeVersionEtcDTO createNewVersion(SfcCciDTO cci, java.lang.Integer version, java.lang.Integer workVersion) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- the cciversion
- the versionworkVersion
- the work versioneu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcProgrammeVersionEtcDTO create(SfcCciDTO cci, java.lang.String title, java.lang.Short firstYear, java.lang.Short lastYear, java.lang.String comments) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- title
- firstYear
- lastYear
- comments
- optional parametereu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public void save(SfcProgrammeVersionEtcDTO version) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
The saving of a programme version is not an official send. It just saves the data into the database. Then, once saved, the programme 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 programme 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 programme.
The programmeVersion argument must always be provided if not an SfcFaultException will be thrown.
version
- The ProgrammeVersion to save.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcProgrammeVersionEtcDTO partialSave(SfcProgrammeVersionEtcDTO version) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcSearchResultDTO<SfcProgrammeVersionEtcDTO> 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>2014</cci>
<!--Optional:-->
<version>1</version>
<!--Optional:-->
<workVersion>0</workVersion>
<!--Optional:-->
<status>OPN</status>
<!--Optional:-->
<currentNode>BE</currentNode>
<!--Optional:-->
<decisionNumber>C(2014)</decisionNumber>
</criteria>
</query>
query
- SfcProgrammesQueryDTOeu.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 cancel(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
- 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.