@SchemaValidation(handler=eu.europa.ec.sfc2014.frontoffice.jws.SchemaValidationErrorHandler.class) public class Annex3CollectionServiceJwsImpl extends eu.europa.ec.sfc2014.frontoffice.jws.service.search.GenericServiceJwsImpl<SfcAnnex3CollectionVersionDTO,eu.europa.ec.sfc2014.frontoffice.model.dto.mvo.search.Annex3CollectionListContainer,eu.europa.ec.sfc2014.frontoffice.model.domain.annex3.Annex3CollectionVersion,eu.europa.ec.sfc2014.frontoffice.model.util.MainVersionObjectCriteria,SfcAnnex3CollectionCriteriaDTO,SfcAnnex3CollectionQueryDTO>
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 |
---|
Annex3CollectionServiceJwsImpl() |
Modifier and Type | Method and Description |
---|---|
SfcAnnex3CollectionVersionDTO |
create(SfcCciDTO cci)
To be used when a user wants to create a new Collection of SCO data
|
SfcAnnex3CollectionVersionDTO |
createNewVersion(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to create a new version of Collection of SCO data.
|
void |
delete(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
To be used when a user wants to delete a Collection of SCO data version from the system.
|
SfcAnnex3CollectionVersionDTO |
partialSave(SfcAnnex3CollectionVersionDTO version) |
SfcAnnex3CollectionVersionDTO |
read(SfcCciDTO cci,
java.lang.Integer version,
java.lang.Integer workVersion)
Returns a single Collection of SCO data object 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 Collection of SCO data version sent by the Member State/Region because
it is incomplete or incorrect and needs to be modified.
|
SfcAnnex3CollectionVersionDTO |
save(SfcAnnex3CollectionVersionDTO version)
Saves a Collection of SCO data version.
|
SfcSearchResultDTO<SfcAnnex3CollectionVersionDTO> |
search(SfcAnnex3CollectionQueryDTO query)
Searches for Collection of SCO data based on the given Criteria
|
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 Collection of SCO data 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 Collection of SCO data
|
public SfcAnnex3CollectionVersionDTO read(SfcCciDTO cci, java.lang.Integer version, java.lang.Integer workVersion) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
This method returns the Annex3 Collection Data 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>05</leadDg>
<budgetSource>FM</budgetSource>
<objectSubType>OP</objectSubType>
<sequence>013</sequence>
</cci>
<!--Optional:-->
<version>201401</version>
<!--Optional:-->
<workVersion>0</workVersion>
cci
- The CCI of the Programmeversion
- The version number of the Collection of SCO dataworkVersion
- The workVersion of the Collection of SCO dataeu.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 CCI of the Programmeversion
- The version number of the Collection of SCO dataworkVersion
- The workVersion of the Collection of SCO datalocale
- The language of the Contents. Can be null
.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcSearchResultDTO<SfcAnnex3CollectionVersionDTO> search(SfcAnnex3CollectionQueryDTO 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
- SfcAnnex3CollectionQueryDTOeu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcAnnex3CollectionVersionDTO save(SfcAnnex3CollectionVersionDTO 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
- The Collection of SCO data to save.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcAnnex3CollectionVersionDTO partialSave(SfcAnnex3CollectionVersionDTO version) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public SfcAnnex3CollectionVersionDTO 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 Collection of SCO data 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 SfcAnnex3CollectionVersionDTO create(SfcCciDTO cci) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
cci
- of the programmeeu.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 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.