En este apartado se explicarán los servicios de pfi y cómo inicializar su cliente java

ÍNDICE DEL CONTENIDO

Inicialización del cliente mediante CXF

Mediante sintaxis xml podemos definir fácilmente la configuración del cliente CXF para que acceda a los servicios de PFI. Inicialmente deberemos definir la referencia a la interfaz del servicio, que se encuentra dentro del cliente suministrado, así como a la dirección a la que apunta el wsdl levantado.

IDocumentIntegrationService

<simple:client id="pfiClient" 
			   serviceClass="es.aragon.pfi.core.ws.IDocumentIntegrationService" 
			   address="http://[entorno:puerto]/pfi_core/services/IDocumentIntegrationServiceWS"
			   serviceName="s:IDocumentIntegrationService" 
			   xmlns:s="http://ws.core.pfi.aragon.es/ "
		       endpointName="s:IDocumentIntegrationServiceWS"
>
	<simple:outInterceptors>
		<ref bean="authorizeInterceptor" />
	</simple:outInterceptors>
</simple:client>

Como se puede observar en la definición XML del cliente CXF, se deberán configurar las urls donde se ubica el servicio IDocumentIntegrationServiceWS, para ello habrá que sustituir entorno y puerto por los valores correctos.
Las aplicaciones que se integran con PFI deben proporcionar en todas las peticiones el código de aplicación.

Para ello, utilizando los denominados interceptores, es posible rellenar este valor automáticamente en todas las peticiones. Como se ve en la definición del cliente se ha definido un interceptor de salida que entra en funcionamiento en el momento de construir la petición SOAP y que inserta el valor del código de aplicación en los parámetros de todos los métodos de PFI invocados.

<simple:outInterceptors>
	<ref bean="authorizeInterceptor" />
</simple:outInterceptors>

La definición al bean authotizeInterceptor que se incluye a continuación, permite indicarle el código de la aplicación, de esta manera el interceptor se encarga de establecer dicho valor en todos los parámetros de las llamadas a los servicios PFI. La clase con el interceptor de salida AuthorizeOutInterceptor se proporciona junto con el cliente de PFI.

<bean id="authorizeInterceptor" class="es.aragon.pfi.core.util.interceptors.AuthorizeOutInterceptor">
	<property name="applicationId" value="[código aplicación llamante]"/>
</bean>

-

Capturar notificaciones sobre cambios de estado en los documentos

Las aplicaciones integradoras deben definir un servlet al que invoque PFI cuando cambie el estado de un documento, no obstante, se puede consultar directamente al repositorio una vez que haya sido notificado el cambio para garantizar el último estado real.

No debe utilizarse la consulta directa al repositorio como mecanismo de control del estado de los documentos, ya que el número de llamadas recurrentes genera sobrecarga en los entornos, causando problemas tanto al propio integrador como al resto de los usuarios.

Dicho servlet se invocará con tres parámetros mediante querystring:

Parámetro	Descripción
idApp	PFI
CSV	Identificador del documento que ha sufrido un cambio de estado
estado	Estado en que se ha quedado el documento, borrador(1) u original(0)

-

Para que PFI pueda invocar a dicha url, ésta debe estar asociada a la aplicación a través de la plataforma PAU, en el atributo responseUrl correspondiente a la aplicación. Para ello el integrador deberá completar primero el 4.- Servicios de PFI#Procedimiento de alta descrito previamente en este manual.

-

Servicios SignerService

Método 'findQuickSignerList'

Método que busca una lista de firmantes compuesta por -el usuario -su jefe -el jefe de su jefe -los cinco últimos firmantes en su histórico

Más detalles

Signatura

List<Signer> findQuickSignerList(SignerSearch signerSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
signerSearch	4.- Servicios de PFI#SignerSearch	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
signerList	List<4.- Servicios de PFI#Signer>	Lista de firmantes encontrados según los criterios de búsqueda indicados

Códigos error

Código	Descripción
SIGNERSERVICEIMPL_FINDQUICKSIGNERLIST	Error genérico durante el servicio findQuickSignerList
ORGANISMLIST_XX	Error durante la consulta de los datos en SIU (XX indica el código de error en SIU)

Ejemplos de invocación

Ejemplo de invocación

SignerSearch signerSearch = new SignerSearch();
signerSearch.setSignerNif("25448659X");
List<Signer> signerList = iSignerImpl.findQuickSignerList(signerSearch);

Método 'findSignerList'

Método que busca una lista de firmantes atendiendo a unos parámetros de búsqueda

Más detalles

Signatura

List<Signer> findSignerList(SignerSearch signerSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
signerSearch	4.- Servicios de PFI#SignerSearch	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
signerList	List<4.- Servicios de PFI#Signer>	Lista de firmantes encontrados según los criterios de búsqueda indicados

Códigos error

Código	Descripción
SIGNERSERVICEIMPL_FINDSIGNERLIST	Error genérico durante el servicio findSignerList
GET_ORGANISM_HISTORICAL_INFORMATION_XX	Error durante la consulta de los datos en SIU (XX indica el código de error en SIU)

Ejemplos de invocación

Ejemplo de invocación

SignerSearch signerSearch = new SignerSearch();
signerSearch.setOrganismCode("ORG0001");
List<Signer> signerList = iSignerImpl.findSignerList(signerSearch);

Método 'findSignerByNif'

Método que busca un firmante atendiendo a unos parámetros de búsqueda establecidos en concreto se buscará el firmante que corresponde a un Nif

Más detalles

Signatura

Signer findSignerByNif(SignerSearch signerSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
signerSearch	4.- Servicios de PFI#SignerSearch	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
signer	4.- Servicios de PFI#Signer	Firmante cuyo nif coincida con el proporcionado en el parámetro de búsqueda

Códigos error

Código	Descripción
SIGNERSERVICEIMPL_FINDSIGNERBYNIF	Error genérico durante el servicio findSignerByNif
GET_USER_INFORMATION_XX	Error durante la consulta de los datos en SIU (XX indica el código de error en SIU)

Ejemplos de invocación

Ejemplo de invocación

SignerSearch signerSearch = new SignerSearch();
signerSearch.setUserNif("78965412X");
Signer signer = iSignerImpl.findSignerByNif(signerSearch);

Método 'findProposedSigner'

Método que busca un firmante propuesto para un documento atendiendo a unos criterios de búsqueda

Más detalles

Signatura

ParamProposedSigner findProposedSigner(ParamProposedSignerSearch paramProposedSignerSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
paramProposedSignerSearch	4.- Servicios de PFI#ParamProposedSignerSearch	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
proposedSigner	4.- Servicios de PFI#ParamProposedSigner	Firmante propuesto encontrado según los criterios de búsqueda indicados

Códigos error

Código	Descripción
SIGNERSERVICEIMPL_FINDPROPOSEDSIGNER	Error genérico durante el servicio findProposedSigner

Ejemplos de invocación

Ejemplo de invocación

ParamProposedSignerSearch paramProposedSignerSearch = new ParamProposedSignerSearch();
paramProposedSignerSearch.setSignerNif("78965412X");
ParamProposedSigner proposedSigner = iSignerImpl.findProposedSigner(paramProposedSignerSearch);

Método 'findProposedSignerList'

Método que busca la lista de firmantes propuestos según los criterios establecidos en el parámetro de entrada

Más detalles

Signatura

ParamProposedSignerList findProposedSignerList(ParamProposedSignerSearch paramProposedSignerSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
paramProposedSignerSearch	4.- Servicios de PFI#ParamProposedSignerSearch	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
proposedSignerList	ParamProposedSignerList	Objeto que encapsula la lista de firmantes propuestos encontrados y el tamaño de dicha lista

Códigos error

Código	Descripción
SIGNERSERVICEIMPL_FINDPROPOSEDSIGNERLIST	SIGNERSERVICEIMPL_FINDPROPOSEDSIGNERLIST

Ejemplos de invocación

Ejemplo de invocación

ParamProposedSignerSearch paramProposedSignerSearch = new ParamProposedSignerSearch();
paramProposedSignerSearch.setSignerNif("78965412X");
ParamProposedSignerList proposedSigner = iSignerImpl.findProposedSignerList(paramProposedSignerSearch);

Método 'saveProposedSigner'

Método que guarda en base de datos un firmante propuesto correspondiente a un documento

Más detalles

Signatura

ParamProposedSigner saveProposedSigner(ParamProposedSigner paramProposedSigner, Document document)

Parámetros de invocación

Nombre	Tipo	Descripción
paramProposedSigner	4.- Servicios de PFI#ParamProposedSigner	Parámetro que encapsula los datos del firmante propuesto
document	4.- Servicios de PFI#Document	Documento al que se asociarán los firmantes propuestos

Parámetros de respuesta

Nombre	Tipo	Descripción
result	4.- Servicios de PFI#ParamProposedSigner	Objeto que encapsula los datos del firmante propuesto que se almacenado en la base de datos

Códigos error

Código	Descripción
SIGNERSERVICEIMPL_SAVEPROPOSEDSIGNER	Error genérico durante el servicio saveProposedSigner
PROPOSEDSIGNERMANAGER_FINDPROPOSEDSIGNERLIST	Error inesperado al buscar en la tabla de firmantes propuestos
SIGNMANAGERIMPL_FINDSIGNBEANBYPROPOSEDSIGNERBEANID	Error inesperado al buscar una firma a partir de el identificador de un firmante propuesto

Ejemplos de invocación

Ejemplo de invocación

ParamProposedSignerSearch paramProposedSignerSearch = new ParamProposedSignerSearch();
paramProposedSignerSearch.setSignerNif("78965412X");
ParamProposedSigner proposedSigner = iSignerImpl.findProposedSigner(paramProposedSignerSearch);

DocumentSearch documentSearch = new DocumentSearch();
documentSearch.setCsv("CSV6F70H2A66T1E01PFI");
Document document = iDocumentImpl.findDocument(documentSearch);

ParamProposedSigner result = iSignerImpl.saveProposedSigner(paramProposedSigner, document);

Método 'deleteProposedSigner'

Método que borra un firmante propuesto de un documento y reordena el resto de firmantes

Más detalles

Signatura

void deleteProposedSigner(ParamProposedSigner paramProposedSigner, Long documentId)

Parámetros de invocación

Nombre	Tipo	Descripción
paramProposedSigner	4.- Servicios de PFI#ParamProposedSigner	Parámetro que encapsula los datos del firmante propuesto
documentId	Long	Identificador del documento del cual se eliminaran los firmantes propuestos

Parámetros de respuesta

Nombre	Tipo	Descripción

Códigos error

Código	Descripción
SIGNERSERVICEIMPL_DELETEPROPOSEDSIGNER	Error genérico durante el servicio deleteProposedSigner
PROPOSEDSIGNERMANAGER_FINDPROPOSEDSIGNERLIST	Error inesperado al buscar en la tabla de firmantes propuestos
DOCUMENTMANAGERIMPL_FINDDOCUMENT	Error inesperado al buscar el documento

Ejemplos de invocación

Ejemplo de invocación

ParamProposedSignerSearch paramProposedSignerSearch = new ParamProposedSignerSearch();
paramProposedSignerSearch.setSignerNif("78965412X");
ParamProposedSigner proposedSigner = iSignerImpl.findProposedSigner(paramProposedSignerSearch);

DocumentSearch documentSearch = new DocumentSearch();
documentSearch.setCsv("CSV6F70H2A66T1E01PFI");
Document document = iDocumentImpl.findDocument(documentSearch);

iSignerImpl.deleteProposedSigner(paramProposedSigner, document.getId());

Servicios DocumentService

Método 'findDocument'

Método que busca un documento utilizando los criterios de búsqueda establecidos como parámetro de entrada

Más detalles

Signatura

Document findDocument(DocumentSearch documentSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
documentSearch	4.- Servicios de PFI#DocumentSearch	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
document	4.- Servicios de PFI#Document	Documento encontrado según el criterio de búsqueda proporcionada

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENT_02	Error genérico durante el servicio findDocument

Ejemplos de invocación

Ejemplo de invocación

DocumentSearch documentSearch = new DocumentSearch();
documentSearch.setCsv("CSV6F70H2A66T1E01PFI");
Document document = iDocumentImpl.findDocument(documentSearch);

Método 'findDocumentList'

Método que busca una lista de documentos utilizando los criterios de búsqueda establecidos como parámetro de entrada

Más detalles

Signatura

List<Document> findDocumentList(DocumentSearch documentSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
documentSearch	4.- Servicios de PFI#DocumentSearch	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
documentList	List<4.- Servicios de PFI#Document>	Lista de documentos encontrados según los parámetros de búsqueda indicados

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTLIST_01	Error genérico durante el servicio findDocumentList
DOCUMENTSERVICEIMPL_FINDDOCUMENTLIST_02	Error genérico durante el servicio findDocumentList

Ejemplos de invocación

Ejemplo de invocación

DocumentSearch documentSearch = new DocumentSearch();
documentSearch.setState(2);
List<Document> documentList = iDocumentImpl.findDocumentList(documentSearch);

Método 'findDocumentTray'

Método que permite la búsqueda de un listado de documentos para las bandejas a partir del objeto ParamTraySearch

Más detalles

Signatura

ResultTrayList findDocumentTray(ParamTraySearch paramTraySearch)

Parámetros de invocación

Nombre	Tipo	Descripción
paramTraySearch	4.- Servicios de PFI#ParamTraySearch	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultTrayList	ResultTrayList	Lista de documentos para la bandeja que cumplen los criterios de búsqueda

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTTRAY	Error genérico durante el servicio findDocumentTray
FIND_DOCUMENT_LIST	Error al buscar los documentos en bbdd

Ejemplos de invocación

Ejemplo de invocación

ParamTraySearch paramTraySearch = new ParamTraySearch();
paramTraySearch.setDraft(true);
ResultTrayList resultTrayList = iDocumentImpl.findDocumentTray(paramTraySearch);

Método 'findDocumentTrayVisibility'

Método que permite la búsqueda de un listado de documentos para las bandejas a partir del objeto ParamTraySearch incluyendo información de visibilidad

Más detalles

Signatura

ResultTrayListVisibility findDocumentTrayVisibility(ParamTraySearch paramTraySearch)

Parámetros de invocación

Nombre	Tipo	Descripción
paramTraySearch	4.- Servicios de PFI#ParamTraySearch	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultTrayListVisibility	ResultTrayListVisibility	Lista de documentos para la bandeja que cumplen los criterios de búsqueda con información de visibilidad

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTTRAY	Error genérico durante el servicio findDocumentTrayVisibility
PAUINTEGRATION_PROCEDURELISTBYUSER	Error en el sistema de autentificación. Se ha producido el siguiente error al buscar la lista de procedimientos del usuario desde PAU
FIND_DOCUMENT_LIST	Error al buscar los documentos en bbdd

Ejemplos de invocación

Ejemplo de invocación

ParamTraySearch paramTraySearch = new ParamTraySearch();
paramTraySearch.setDraft(true);
ResultTrayListVisibility resultTrayListVisibility = iDocumentImpl.findDocumentTrayVisibility(paramTraySearch);

Método 'findDocumentFolderList'

Método que busca un listado de bloques o carpetas a partir del objeto de búsqueda del documento

Más detalles

Signatura

List<ParamFolder> findDocumentFolderList(DocumentSearch document)

Parámetros de invocación

Nombre	Tipo	Descripción
document	4.- Servicios de PFI#DocumentSearch	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
paramFolder	List<ParamFolder>	Error inesperado al buscar los diferentes folder a los que pertenecen los documentos

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTFOLDERLIST	Error genérico durante el servicio findDocumentFolderList
NOT_EXIST_DOCUMENT

Ejemplos de invocación

Ejemplo de invocación

DocumentMetadataSearch documentMetadataSearch = new DocumentMetadataSearch();

Método 'signDocument'

Método para firmar un documento

Más detalles

Signatura

signDocument(ParamSignDocument paramSignDocument)

Parámetros de invocación

Nombre	Tipo	Descripción
paramSignDocument	4.- Servicios de PFI#ParamSignDocument	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_01	Error al firmar el documento porque ya esta en uso o superado la fecha de firma
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_02	El proceso de firma ha superado la fecha de firma del documento. Por favor, inténtelo de nuevo
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_03	No se puede actualizar el contenido porque ya está en uso
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_04	No se puede cambiar el estado porque ya está en uso
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_05	Error si se trata de firma simple simpre queda firmado, situacion imposible
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_06	No se puede guardar la firma en el documento porque ya está en uso

Ejemplos de invocación

Ejemplo de invocación

ParamSignDocument paramSignDocument = new ParamSignDocument();
paramSignDocument.setCsv("CSV6F70H2A66T1E01PFI");
iDocumentImpl.signDocument(paramSignDocument);

Método 'saveDocument'

Método para guardar los datos de un documento

Más detalles

Signatura

Document saveDocument(Document document)

Parámetros de invocación

Nombre	Tipo	Descripción
document	4.- Servicios de PFI#Document	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
document	4.- Servicios de PFI#Document	El documento resultante de la operación

Códigos error

Código	Descripción
PARSE_CREATE_BLOB	No se ha podido crear el objeto de base de datos para el binario correspondiente
UTILSCORE_GENERATETEMPORALDOCUMENT_01	Error al generar el documento temporal
UTILSCORE_GENERATETEMPORALDOCUMENT_02	Error al generar el documento temporal
DOCUMENTSERVICEIMPL_SAVEDOCUMENT	Error genérico durante el método saveDocument

Ejemplo de invocación

	System.out.println("- PRUEBA 1.1: GUARDAR UN DOCUMENTO Pendiente de firma CON CSV");
		Document document = createNewDocument(Integer.parseInt(EstadoPFI.PENDIENTE_DE_FIRMA), null);
		document.setSaveFile(true);
		try {
			System.out.println("Guardar el documento");
			System.out.println("CSV: " + document.getCsv());
			document = documentServiceWS.saveDocument(document);

			System.out.println("Documento guardado");
		} catch (InternalCoreException e) {
			System.out.println("Error al guardar el documento con csv " + document.getCsv());
			System.out.println("Error: " + e.getMsg());

		}
	public es.aragon.pfi.core.ws.data.Document createNewDocument(Integer state, String csv) {
		es.aragon.pfi.core.ws.data.Document document = new es.aragon.pfi.core.ws.data.Document();
		if (csv == null) {
			document.setCsv(Utils.obtenerCSV());
		} else {
			document.setCsv(csv);
		}
		ParamFile paramFile = new ParamFile();
		paramFile.setContent(new DataHandler(new FileDataSource(new File("./src/main/resources/pdf.pdf"))));
		paramFile.setFileName("test.pdf");
		paramFile.setFileSize(new Long(1024));
		paramFile.setFileGenerated(new DataHandler(new FileDataSource(new File("./src/main/resources/pdf.pdf"))));
		paramFile.setFileGeneratedDate(new Date());
		document.setFile(paramFile);
		document.setFolder("testFolder");
		document.setPriority(Integer.parseInt(PFICoreConstants.PRIORITY_MEDIUM));
		document.setRejected(PFICoreConstants.DOCUMENT_NOREJECTED);
		document.setSignType(1);
		// XXX: contemplar la creación de un propose_signer con la posición
		// document.setSignaturePosition(PFICoreConstants.SIGNATURE_POS_NOSIGN);
		document.setState(state);
		document.setMetadataCache(createMetadataCache());
		return document;
	}

	public static Map<ParamMetadataId, ParamMetadata> createMetadataCache() {
		Map<ParamMetadataId, ParamMetadata> metadataCache = new HashMap<ParamMetadataId, ParamMetadata>();
		// Se crea el firmante propuesto
		ParamMetadata paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.SIGNER_ENTITY);
		paramMetadata.setMetadataName("agente_desc_nombre");
		paramMetadata.setMetadataValue("LUCIA CASPE - CADUCADO PRUEBAS AUTOMATIZADAS");
		ParamMetadataId paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.SIGNER_ENTITY);
		paramMetadata.setMetadataName("agente_ident_identificacion");
		paramMetadata.setMetadataValue("96666666N");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		// Se crea el preparador
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.ISSUER_ENTITY);
		paramMetadata.setMetadataName("agente_desc_nombre");
		paramMetadata.setMetadataValue("LUCIA CASPE - CADUCADO PRUEBAS AUTOMATIZADAS");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.SIGNER_ENTITY);
		paramMetadata.setMetadataName("agente_ident_identificacion");
		paramMetadata.setMetadataValue("96666666N");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		// Se crea la fecha de captura
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_ident_fecha_captura");
		paramMetadata.setMetadataValue(Utils.fechaISO86012004(new Date()));
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		// Se crea la descripción
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_desc_descripcion");
		paramMetadata.setMetadataValue("Documento de test");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		// Se crea el procedimiento
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_cont_nom_procedimiento");
		paramMetadata.setMetadataValue("AYUDA A LOS CONTRATOS AGRARIOS");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_cont_codprocedimiento");
		paramMetadata.setMetadataValue("404");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		// Se crea el tipo de documento
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_desc_tipo_documento");
		paramMetadata.setMetadataValue("ACUERDO");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		// Se crea el estado y el origen
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_desc_estado");
		paramMetadata.setMetadataValue("0");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_ident_origen");
		paramMetadata.setMetadataValue("1");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		return metadataCache;
	}

Método 'findMetadataValue'

Método para guardar los datos de un documento

Más detalles

Signatura

findMetadataValue(ParamMetadata paramMetadata)

Parámetros de invocación

Nombre	Tipo	Descripción
paramMetadata	4.- Servicios de PFI#ParamMetadata	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
value	String	El valor de metadato encontrado

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDMETADATAVALUE	Error genérico durante el servicio findMetadataValue

Ejemplos de invocación

Ejemplo de invocación

ParamMetadata paramMetadata = new ParamMetadata();
paramMetadata.setMetadataName("metatada-name");
String value = iDocumentImpl.findMetadataValue(paramMetadata);

Método 'getDocumentState'

Método para obtener el estado del documento

Más detalles

Signatura

Integer getDocumentState(ParamGetDocumentState paramGetDocumentState)

Parámetros de invocación

Nombre	Tipo	Descripción
paramGetDocumentState	4.- Servicios de PFI#ParamGetDocumentState	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre

Tipo

Descripción

state

Integer

Numero de estado correspondiente en porta-firmas:

6 → En paralelo

4 → Anulado

3 → Firma Programada

2 → Firmado

1 → Pendiente de firma

0 → Borrador

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_GETDOCUMENTSTATE	Error genérico durante el servicio getDocumentState
FIND_DOCUMENT	Error inesperado al buscar un documento
DOCUMENTMANAGERIMPL_FINDDOCUMENT	Error buscando documento

Ejemplos de invocación

Ejemplo de invocación

ParamGetDocumentState paramGetDocumentState = new ParamGetDocumentState();
paramGetDocumentState.setCsv("CSVP55RYQS7R9AF01PFI");
Integer documentState = IDocumentService.getDocumentState(paramGetDocumentState);

Método 'setDocumentState'

Método para cambiar el estado de un documento

Más detalles

Signatura

void setDocumentState(ParamSetDocumentState paramSetDocumentState)

Parámetros de invocación

Nombre	Tipo	Descripción
paramSetDocumentState	4.- Servicios de PFI#ParamSetDocumentState	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_03	No se puede actualizar el contenido porque ya está en uso
DOCUMENTSERVICEIMPL_SETDOCUMENTSTATE	Error genérico durante el metodo setDocumentState
DOCUMENTMANAGERIMPL_FINDDOCUMENTLIST	Error inesperado al buscar una lista de documentos

Ejemplos de invocación

Ejemplo de invocación

ParamSetDocumentState paramSetDocumentState = new ParamSetDocumentState();
paramSetDocumentState.setCsv("CSVP55RYQS7R9AF01PFI");
paramSetDocumentState.setState(0);
IDocumentService.setDocumentState(paramGetDocumentState);

Método 'getOperation'

Método para obtener la operación asociada al documento

Más detalles

Signatura

ResultGetOperation getOperation(ParamGetOperation paramGetOperation)

Parámetros de invocación

Nombre	Tipo	Descripción
paramGetOperation	ParamGetOperation	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultGetOperation	ResultGetOperation	Objeto que encapsula el resultado de la operación

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_GETOPERATION	Error genérico durante el servicio getOperation
SCDEINTEGRATION_GETSTATUS	Error al comprobar el estado de la operacion
LOAD_OPERATION	Error buscando operación. El usuario no tiene permisos para ver la operación
FIND_OPERATION	Error buscando operación

Ejemplos de invocación

Ejemplo de invocación

ParamGetOperation paramGetOperation = new ParamGetOperation();
paramGetOperation.setDocumentId(1L);
ResultGetOperation resultGetOperation = IDocumentService.getOperation(paramGetOperation);

Servicios AdviceService

Método 'sendAdvice'

Método que manda un aviso utilizando el sistema de cola de sga para informar de algún cambio en un documento

Más detalles

Signatura

void sendAdvice(Integer noteType, String csv, String text, String userAdviser)

Parámetros de invocación

Nombre	Tipo	Descripción
noteType	Integer	Define el tipo de nota para identificar qué cambio ha sufrido el documento
csv	String	Código seguro de verificación del documento que genera el aviso
text	String	Contenido de aviso
userAdviser	String	NIF de usuario que ha generado el aviso

Parámetros de respuesta

Nombre	Tipo	Descripción

Códigos error

Código	Descripción
ADVICESERVICEIMPL_SENDADVICE	Error genérico durante el servicio sendAdvice
DOCUMENTMANAGERIMPL_FINDDOCUMENT	Error inesperado al buscar el documento

Ejemplos de invocación

Ejemplo de invocación

String userNif = "12345678X";
DocumentSearch documentSearch = new DocumentSearch();
documentSearch.setCsv("CSV6F70H2A66T1E01PFI");
Document document = iDocumentImpl.findDocument(documentSearch);

IAdviceService.sendAdvice(PFICoreConstants.NOTE_TYPE_PROPOSEDSIGNER, document.getCsv(), null, userNif);

Método 'sendMail'

Método que manda un correo electrónico de manera inmediata mediante sga para informar de algún cambio en un documento

Más detalles

Signatura

void sendMail(String fiscalAnagram, String asunto, String mensaje)

Parámetros de invocación

Nombre	Tipo	Descripción
fiscalAnagram	String	Identificación fiscal
asunto	String	Asunto de mensaje que se enviará
mensaje	String	Contenido de mensaje que se enviará

Parámetros de respuesta

Nombre	Tipo	Descripción

Códigos error

Código	Descripción
ADVICESERVICEIMPL_SENDMAIL	Error genérico durante el servicio sendMail
SENDADVICE_ADVICEMANAGER	Error al generar el aviso por correo

Ejemplos de invocación

Ejemplo de invocación

String userNif = "12345678X";
String message = "...";

IAdviceService.sendAdvice(userNif, "Operacion finalizada", message);

Servicios DocumentIntegrationService

Método 'sendDocumentumDocument'

Cuando una aplicación que integra Porta-firmas almacena un documento en Documentum y desea que quede guardado en Porta-firmas, invoca este servicio para que posteriormente Porta-firmas pueda hacer uso de dicho documento.

Más detalles

Signatura

ResultSendDocument sendDocumentumDocument(ParamSendDocument paramSendDocument)

Parámetros de invocación

Nombre	Tipo	Descripción
paramSendDocument	4.- Servicios de PFI#ParamSendDocument	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultSendDocument	4.- Servicios de PFI#ResultSendDocument	Objeto que encapsula el resultado de la operación, proporcionado información en caso de error

Códigos error

Código	Descripción
DOCUMENTINTEGRATIONMANAGERIMPL_SENDDOCUMENTUMDOCUMENT	Error inesperado al crear un documento en la tabla de PFI_DOCUMENT
DOCUMENTMANAGERIMPL_FINDDOCUMENT	Error inesperado al buscar un documento
LOAD_DOCUMENT	Error cargando documentos
SIUINTEGRATION_SENDPROPOSEDSIGNERS	Error en el sistema de identificación. El firmante propuesto debe estar dado de alta en el sistema de identificación de usuarios (SIU)

Ejemplos de invocación

Ejemplo de invocación

ParamSendDocument paramSendDocument = new ParamSendDocument();
paramSendDocument.setCsv("CSVDA6FLBW3PNAX01PFI");
paramSendDocument.setApplicationId("PFI");
paramSendDocument.setUserNif("00000000T");
ResultSendDocument resultSendDocument = iDocumentIntegrationImpl.sendDocumentumDocument(paramSendDocument);

Método 'updateQuorumAndLimitDateDocument'

Método que actualiza el número mínimo de firmantes que deben firmar un documento y fecha límite de firma en los documentos con más de un firmante

Más detalles

Signatura

ResultUpdateQuorumAndLimitDate updateQuorumAndLimitDateDocument (ParamUpdateQuorumAndLimitDate paramUpdateQuorumAndDate)

Parámetros de invocación

Nombre	Tipo	Descripción
paramUpdateQuorumAndDate	4.- Servicios de PFI#ParamUpdateQuorumAndLimitDate	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultUpdateQuorum	4.- Servicios de PFI#ResultUpdateQuorumAndLimitDate	Objeto que encapsula el resultado de la operación, proporcionado información en caso de error

Códigos error

Código	Descripción
QUORUMTASK_DOCUMENTNONEXISTING	El documento con el CSV especificado no existe en la base de datos de PFI
QUORUMTASK_QUORUMWRONG	El valor de quorum indicado es incorrecto. Debe ser mayor que 0 y menor o igual que el número de firmantes propuestos del documento
QUORUMTASK_DATEWRONG	La fecha límite de firma del documento ha expirado
QUORUMTASK_NOMULTIFIRMA	El documento no es multifirma
QUORUMTASK_SIGNED	El documento ya ha sido firmado por alguno de los firmantes

Ejemplos de invocación

Ejemplo de invocación

ParamUpdateQuorumAndLimitDate paramUpdateQuorumAndDate = new ParamUpdateQuorumAndLimitDate();
paramUpdateQuorumAndDate.setCsv("CSVP55RYQS7R9AF01PFI");
paramUpdateQuorumAndDate.setQuorum(2);
//queremos de fecha límite por ejemplo el día de hoy más una semana
Calendar cal = Calendar.getInstance();
cal.setTime(new Date());
Integer incFecha = 7;
cal.add(Calendar.DATE, incFecha);
paramCheckQuorumAndDate.setDate(cal.getTime());
paramCheckQuorumAndDate.setQuorumOnly(false);

ResultUpdateQuorumAndLimitDate resultCheckQuorumAndDate = iDocumentIntegrationImpl.updateQuorumAndLimitDateDocument(paramUpdateQuorumAndDate);

Suscripción a eventos

PFI se integra con SGA para el envío de eventos. Para que una aplicación pueda recibir los eventos de PFI, es necesario que esté dada de alta en SGA y que publique un servicio web para la recepción de los eventos. En el manual de SGA se explica cómo publicar el servicio web para poder recibir los eventos.

PFI envía eventos a través de los siguientes métodos:

expiredDocument → Método que informa los documentos que han quedado expirados por no haber sido firmados antes de la fecha límite configurada. En los datos del evento llega el código CSV del documento y su estado. Los estados a recibir son los siguientes:
- Estado 0 (BORRADOR ) → Un documento queda expirado en estado 0 (BORRADOR) cuando no tiene ninguna firma realizada y no ha sido firmado antes de la fecha límite configurada
- Estado 2 (FIRMADO) → Un documento queda expirado en estado 2 (FIRMADO) cuando tiene todas las firmas necesarias realizadas pero por algún motivo ha quedado en el estado erróneo y no se ha cumplido la fecha límite configurada

Ejemplo de datos del evento que recibiría la aplicación destino:

La aplicación destino que desee recibir los eventos debe estar suscrita en SGA al método expiredDocument de PFI. Además, en PAU deberá tener permiso sobre el método expiredDocument de PFI.

sendEvent → Método que informa sobre los cambios de estado de los documentos de PFI. Para poder recibir estos eventos de cambios de estado, los documentos deben tener asignado el alias de la aplicación receptora en el metadato dea_ident_codigo_aplicacion. De lo contrario, no se recibirán los eventos. El evento se compone de clave y valor. La clave es el CSV del documento y el valor es el estado del documento. Los cambios de estado que se notifican son los siguientes:
- Estado 3 (Firmando asíncronamente) → Estado al que se pasan los documentos al inicio del proceso de firma para indicar que se está realizando la firma del documento.
- Estado 6 (Firma paralela) → Se alcanza este estado cuando un documento tiene varios firmantes propuestos y alguno de ellos ya ha firmado pero todavía no se cumple el quorum.
- Estado 2 (Firmado) → Documento firmado.
- Estado 0 (Borrador) → Se recibe este evento cuando se rechaza un documento pendiente de firma.
- Estado 9 (Anulado) → Se recibe este evento cuando se anula un documento.

Ejemplo de datos del evento que recibiría la aplicación destino:

La aplicación destino que desee recibir los eventos debe estar suscrita en SGA al método sendEvent de PFI. Además, en PAU deberá tener permiso sobre el método sendEvent de PFI.

Anexos

Objectos Comunes

Objeto 'SignerSearch'

Nombre	Tipo	Descripción
auditorNif	String	Nif del auditor a buscar
signerNif	String	Nif del firmante para el que se quieren buscar auditores
fiscalAnagram	String	Nif del usuario identificado en la aplicación
organismCode	String	Código de organismo del firmante
name	String	Nombre del firmante
surname1	String	Primer apellido de firmante
surname2	String	Segundo apellido de firmante
email	String	E-mail del firmante
roleCode	String	Código del rol del usuario
userOrganismCode	String	Código de organismo de usuario
prepararOtrasRamas	boolean	Indica si el usuario tiene acceso a ramas diferentes a la suya
fromIndex	int	Índice a partir del que se quieren obtener los auditores
toIndex	int	Índice hasta el que se permite devolver auditores
maxResults	int	Máximo número de auditores que se devuelven
sortColumn	String	Indica la ordenación de los resultados
ascending	Boolean	Indica si la ordenación de los resultados es ascendente o descendente
active	Boolean	Indica si han de ser activos los firmantes encontrados o no

Objeto 'Signer'

Nombre	Tipo	Descripción
name	Long	Nombre del firmante
surname1	String	Primer apellido del firmante
surname2	String	Segundo apellido del firmante
nif	String	Nif del firmante
fiscalAnagram	String	Anagrama fiscal del auditor
organism	String	Organismos en los que firma
role	String	Nombre del rol del firmante
roleCode	String	Código del rol del firmante
organismCode	String	Nombre del organismo en el que firma

Objeto 'ParamProposedSignerSearch'

Nombre	Tipo	Descripción
signerNif	String	Nif del firmante propuesto
signerName	String	Nombre del firmante propuesto
signerDateTo	Date	Indica el inicio del periodo para cotejar la fecha de firma
signerDateFrom	Date	Indica el final del periodo para cotejar la fecha de firma
signaturePosition	Integer	Tipo de posición de los pies de firma
signerOrder	Integer	Orden de firma del firmante propuesto
position	String	Coordenadas donde se ha colocado el pie de firma del firmante propuesto
delegationText	String	Texto de delegación del firmante propuesto
signed	Integer	Indica si el firmante propuesto ha firmando (1) o no (0)
signerOrgCode	String	Código de organismo del firmante propuesto
document	Document	Documento para el el cual se buscarán los firmantes propuestos
signerStatus	String	Condición del firmante
fromIndex	int	Índice a partir del que se quieren obtener los auditores
toIndex	int	Índice hasta el que se permite devolver auditores
maxResults	int	Máximo número de auditores que se devuelven
sortColumn	String	Indica la ordenación de los resultados
ascending	Boolean	Indica si la ordenación de los resultados es ascendente o descendente

Objeto 'ParamProposedSigner'

Nombre	Tipo	Descripción
proposedSignerId	Long	Id del firmante propuesto
signerNif	String	Nif del firmante propuesto
signerName	String	Nombre del firmante propuesto
signerDateFrom	String	Fecha de selección del firmante
signerOrder	String	Orden de firma del firmante propuesto
signaturePosition	String	Tipo de posición de los pies de firma
position	String	Coordenadas donde se ha colocado el pie de firma del firmante propuesto
delegationText	String	Texto de delegación del firmante propuesto
signed	String	Indica si el firmante propuesto ha firmando (1) o no (0)
signerOrgCode	String	Código de organismo del firmante propuesto
signerOrganism	String	Nombre de organismo del firmante propuesto
signerRole	String	Cargo del firmante propuesto
signerStatus	String	Condición del firmante
revised	String	Indica si el firmate propuesto ha sido revisado o no. Valores: S o N
deleteSign	Boolean	Indica si se ha de borrar la firma al actualizar el firmante propuesto

Objeto 'DocumentMetadata'

Nombre	Tipo	Descripción
signerName	String	Si se mostrará el documento (S), o no (N)
signerSurname	String	Apellidos del firmante
signerNif	String	Nif del firmante
auditorName	String	Nombre de auditor
auditorSurname	String	Apellidos de auditor
auditorNif	String	Nif de auditor
description	String	Descripción del metadato
documentType	String	Tipo de documento
procedure	String	Nombre de procedimiento
metadataName	String	Nombre del metadato
metadataValue	String	Valor del metadato

Objeto 'DocumentMetadataSearch'

Nombre	Tipo	Descripción
documentMetadataId	Long	Id del registro en el historial
signerName	String	Si se mostrará el documento (S), o no (N)
signerSurname	String	Apellidos del firmante
signerNif	String	Nif del firmante
auditorName	String	Nombre de auditor
auditorSurname	String	Apellidos de auditor
auditorNif	String	Nif de auditor
description	String	Descripción de metadato
documentType	String	Tipo de documento
procedure	String	Nombre del procedimiento
metadataName	String	Nombre del metadato
metadataValue	String	Valor del metadato

Objeto 'DocumentSearch'

Nombre	Tipo	Descripción
documentId	Long	Id del documento a buscar
documentIds	List<Long>	Lista de ids a buscar
csv	String	Código seguro de verificación del documento
lookUpDocumentumData	Boolean	Buscar datos en documentum
lookUpStampSigned	Boolean
lookUpLetDocumentStamp	Boolean
lookUpProposedSigners	Boolean	Buscar firmantes propuestos
lookUpFile	String	Buscar fichero
state	Integer	Estado del documento
csvAuthorized	String	Código seguro de verificación autorizado
isDetail	Boolean	Indica si es detalle
modifiedState	Boolean	Si el documento ha cambiado de estado
esDocAnulacion	String	Si es un documento de anulación
csvAnulacion	String	CSV del documento de anulación asociado
csvSustitucion	String	CSV del documento de sustitución asociado

Objeto 'ParamTraySearch'

Nombre	Tipo	Descripción
metadataId	Long	Id del documento a buscar
metadataName	String	Lista de ids a buscar
issuerName	String	Código seguro de verificación del documento
signerName	String	Buscar datos en documentum
signerNif	String	Nif del firmante
issuerNif	String	Buscar firmantes propuestos
recipient	String	Buscar fichero
description	String	Estado del documento
documentType	String	Código seguro de verificación autorizado
documentCopyOriginal	String	Indica si es detalle
folder	String	Si el documento ha cambiado de estado
state	Integer	Si es un documento de anulación
preparationDateFrom	Date	CSV del documento de anulación asociado
preparationDateTo	Date	CSV del documento de sustitución asociado
procedure	String	Nombre del procedimiento
signed	Boolean	Documento firmado o no firmado
draft	Boolean	Indica si el documento es un borrador
pendingSignature	Boolean	Indica si el documento esta pendiente de firma
auditor	Boolean	Es auditor
generalAuditor	Boolean	Es auditor general
fromIndex	int	Índice a partir del que se quieren obtener los documentos
toIndex	int	Índice hasta el que se permite devolver los documentos coincidentes
maxResults	int	Cantidad de documentos máxima que se devolverá
sortColumn	String	Indica la ordenación de los resultados
ascending	Boolean	Indica si la ordenación de los resultados es ascendente o descendente

Objeto 'Document'

Nombre	Tipo	Descripción
applicationId	String	Aplicación que ejecuta el método
userNif	String	Nif del usuario
documentId	Long	Id del documento.
csv	String	Csv generado por CCSV para el documento.
state	Integer	Estado del documento en el sistema. Puede tomar los siguientes valores: 0:borrador, 1: pendiente de firma, 2: firmado, 3: firmando asíncrona-mente, 4: eliminado
rejected	String	Indica que el documento ha sido rechazado “S” o que no ha sido rechazado “N”. Por defecto “N”.
folder	String	Identificador de la carpeta a la que pertenece un documento.
priority	Integer	Prioridad del documento, por defecto 1: 0: baja 1: media 2:alta
csvAutorized	String	Csv de un documento de autorización.
operationId	String	Id del proceso de firma que se realiza.
operationState	String	Estado en el que se ha quedado el proceso de firma.
signType	Integer	Tipo de firma del documento.
limitDate	Date	Fecha límite para la firma del documento.
prepateDateInit	Date	Fecha de inicio de la preparación del documento.
prepareDateEnd	Date	Fecha de fin de la preparación del documento.
creatorNif	String	Nif del creador del documento.
quorum	Integer	Mínimo de firmas requeridas para pasar a firmar un documento.
quorumOnly	Boolean	Indica, en el caso de multifirma, si se admiten más firmas que las mínimas requeridas (quorum).
csvDocCancel	String	CSV del documento de cancelación de la operación.
hashDocument	String	Indica el hash del documento.
preloadedImageBase64	byte[]	Array de bytes que contiene la imagen en base64 del documento.
esDocAnulacion	String	Indica si el documento es de anulación “S”.
obligatorioExpediente	String	Indica si el documento es obligatorio para el expediente, en caso de que lo haya, al que va asociado.
asoaciadoAExpediente	Boolean	Indica si el documento está asociado a algún expediente.
metadataCache	Map<ParamMetadataId, ParamMetadata>	Metadatos obtenidos de la tabla PFI_METADATA
metadatas	Map<ParamMetadataId, ParamMetadata>	Mapa con los metadatos del documento ordenados
proposedSigners	Map<String, ParamProposedSigner>	Mapa con todos los firmantes propuestos.
documentumMetadata	Map<String, String>	Mapa con los metadatos que se obtienen de documentum.
metadatosDocumento	List<ParamMetadata>	Lista de los metadatos para los JSP’s
file	ParamFile	Archivo asociado al documento.
oid	String	Número de operación de firma que se realiza
letStamp	Integer	Resultado de la llamada al letDocumentStamp.
showDocument	String	Indica si se ha de mostrar el documento.
saveFile	Boolean	Indica si se tiene que guardar el fichero.
signResult	String	Resultado de la firma del documento.
hasSummaryDocument	Boolean	Indica si el documento tiene un sumario.
modifyState	Integer	Estado al que se ha modificado un documento.
modifyDate	Date	Fecha en la que se ha modificado un documento.

Objeto 'ParamSignDocument'

Nombre	Tipo	Descripción
csv	Long	CSV del documento
nif	String	Nif del firmante
proposedSigner	Long	Identificador del firmante propuesto
allSigned	Boolean
isAuthorization	Boolean	Indica si es un documento de autorización
numberOfSigners	Integer	Indica la cantidad de firmantes
simpleSign	Boolean	Indica si es una firma simple
restoreDocument	Boolean	Si se restaurará el documento

Objeto 'ParamGetDocumentState'

Nombre	Tipo	Descripción
csv	String	Código seguro de verificación del documento
applicationId	String	Aplicación que ejecuta el método
userNif	String	Nif de usuario

Objeto 'ParamSetDocumentState'

Nombre	Tipo	Descripción
csv	String	Código seguro de verificación del documento
state	Integer	Estado actual del documento
modifyState	Integer	Estado al que cambiará el documento
modifyDate	Date	Fecha del cambio de estado del documento

Objeto 'ParamUpdateQuorumAndLimitDate'

Nombre	Tipo	Descripción
csv	String	CSV del documento
quorum	Integer	Cantidad de firmas necesarias para firmar un documento
quorumOnly	Boolean	Indica, en el caso de multifirma, si se admiten más firmas que las mínimas requeridas (quorum).
date	Date	Fecha limite para firmar

Objeto 'ResultUpdateQuorumAndLimitDate'

Nombre	Tipo	Descripción
errorCode	String	Código de error del servicio
returnCode	String	Indica si la llamada ha finalizado correctamente (OK) o en error (ERROR)
errorMessage	String	Descripción del mensaje de error

Objeto 'ParamSendDocument'

Nombre	Tipo	Descripción
applicationId	String	Aplicación que ejecuta el método
userNif	String	Nif del usuario
csv	String	Código seguro de verificación del documento

Objeto 'ResultSendDocument'

Nombre	Tipo	Descripción
returnCode	String	Indica si la llamada ha finalizado correctamente (OK) o en error (ERROR)
errorCode	String	Código de error del servicio
errorMessage	String	Mensaje de error del servicio
exception	String	Excepción producida durante el proceso

Objeto 'ParamGetOperation'

Nombre	Tipo	Descripción
documentId	Long	Identificador único del documento
userNif	String	Nif del usuario que ejecuta el servicio web
applicationId	String	Id de la aplicación que ejecuta al servicio web

Objeto 'ResultGetOperation'

Nombre	Tipo	Descripción
operationId	Long	Identificador único de la operación
operationState	String	Estado actual de la operación
csvAutorized	String
csvDocCancel	String
documentList	List<Document>	Documentos asociados a la operación consultada

-