@SchemaValidation(handler=eu.europa.ec.sfc2014.frontoffice.jws.SchemaValidationErrorHandler.class)
public class DocumentJwsImpl
extends eu.europa.ec.sfc2014.frontoffice.jws.DocumentCommonJwsImpl
Constructor and Description |
---|
DocumentJwsImpl() |
Modifier and Type | Method and Description |
---|---|
void |
ackDocument(java.lang.Long documentId)
Acknowledge reception of a document
|
java.lang.Long |
addDocument(eu.europa.ec.sfc.model.document.v0.DocumentType document)
This operation creates and initialises a new document from scratch.
|
void |
removeDocument(java.lang.Long documentId)
Remove Document
|
java.util.List<eu.europa.ec.sfc.model.document.v0.DocumentType> |
search(SfcDocumentQueryDTO searchCriteria)
Search for a list of documents matching the criteria.
|
void |
sendDocument(java.lang.Long documentId)
Send Document
|
java.lang.Long |
updateDocument(eu.europa.ec.sfc.model.document.v0.DocumentType document)
This operation modifies an existing document.
|
public java.util.List<eu.europa.ec.sfc.model.document.v0.DocumentType> search(SfcDocumentQueryDTO searchCriteria) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
The operation only returns the first 100 items. If you have 100 items, may be the search operation must be refined.
This function is usually called in order to retrieve document information.
searchCriteria
- eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public java.lang.Long addDocument(eu.europa.ec.sfc.model.document.v0.DocumentType document) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
The documentAttachments will be ignored. The client will be able to add attachments, one by one, by calling the appropriate operation and specifying the document identifier.
Only Stand alone documents (not linked to any object in SFC) can be saved without providing the document Link. For the other type of documents a DocumentLinkType should be provided.
Once created, the user will be able to modify the document, add links, attachments, and finally send it. A document that has been sent can no longer be modified.
document
- The document to add.eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
- in case of an errorpublic java.lang.Long updateDocument(eu.europa.ec.sfc.model.document.v0.DocumentType document) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
Since the document must have been created previously the documentID becomes mandatory in the as-a-parameter-provided document.
in this particular case documentLink details will be ignored.
document
- the document to saveeu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
- in case of an errorpublic void removeDocument(java.lang.Long documentId) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
This operation removes a document and all its dependent objects (attachments & document links, etc). The operation takes as parameter the document identifier.
Only unsent documents can be removed.
searchDocument can be used to obtain the Id of the document.
documentId
- The id of the documenteu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
public void sendDocument(java.lang.Long documentId) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
This operation is explicitly sending an existing document, in other words, making it available for lecture to the destination. The document must have been created and must be valid.
Sending a document will freeze it, in the way that it will no longer be modifiable.
Only non-embedded (Non integral) documents can be explicitly send.
The sent date and sentby user will be automatically set.
documentId
- The id of the documenteu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
- in case of errorpublic void ackDocument(java.lang.Long documentId) throws eu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
This use case occurs when a user needs to acknowledge the reception of a document. The notification module will be called to notify the acknowledgement of receipt of the document.
id
- The id of the documenteu.europa.ec.sfc2014.core.model.exceptions.SfcFaultException
- in case of errorCopyright © 2024. All rights reserved.