@SchemaValidation(handler=eu.europa.ec.sfc2014.frontoffice.jws.SchemaValidationErrorHandler.class) public class OperationalProgrammeEmffServiceImpl extends ProgrammeVersionJwsImpl<SfcProgrammeVersionEmffDTO,eu.europa.ec.sfc2014.frontoffice.model.domain.programme.emff.ProgrammeVersionEmff>
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 |
---|
OperationalProgrammeEmffServiceImpl() |
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 an Operational programme version
|
SfcProgrammeVersionEmffDTO |
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 Emff .
|
SfcProgrammeVersionEmffDTO |
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 Operational programme.
|
void |
delete(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to delete a Operational programme version from the system.
|
SfcProgrammeVersionEmffDTO |
partialSave(SfcProgrammeVersionEmffDTO version) |
SfcProgrammeVersionEmffDTO |
read(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
Returns a single 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.
|
SfcProgrammeVersionEmffDTO |
save(SfcProgrammeVersionEmffDTO version)
Saves a Programme Version.
|
SfcSearchResultDTO<SfcProgrammeVersionEmffDTO> |
search(SfcProgrammesQueryDTO query)
Search is equivalent to the UI search of the programme
* This method returns the first section
|
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 an Operational programme 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 Operational programme.
|
public SfcProgrammeVersionEmffDTO 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>BE</targetArea>
<leadDg>14</leadDg>
<budgetSource>MF</budgetSource>
<objectSubType>OP</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 SfcSearchResultDTO<SfcProgrammeVersionEmffDTO> 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:-->
<currentNode>BE</currentNode>
</criteria>
</query>
query
- SfcProgrammesQueryDTOeu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcProgrammeVersionEmffDTO 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 SfcProgrammeVersionEmffDTO 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 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
public SfcProgrammeVersionEmffDTO save(SfcProgrammeVersionEmffDTO 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
- SfcProgrammeVersionEmffDTO to save.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcProgrammeVersionEmffDTO partialSave(SfcProgrammeVersionEmffDTO version) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
Copyright © 2024. All rights reserved.