1 Servicio AdministrativeFileService
- 1.1 Métodos para la gestión de expedientes
  - 1.1.1 Método 'getAdministrativeFile'
    - 1.1.1.1 Invocación
  - 1.1.2 Método 'getAdminFileLiteAdv'
    - 1.1.2.1 Invocación
  - 1.1.3 Método 'getDocumentXml'
    - 1.1.3.1 Invocación
  - 1.1.4 Método 'initializeAdministrativeFileMetadata'
    - 1.1.4.1 Invocación
  - 1.1.5 Método 'openAdministrativeFile'
    - 1.1.5.1 Invocación
  - 1.1.6 Método 'closeAdministrativeFile'
    - 1.1.6.1 Invocación
  - 1.1.7 Método 'reopenAdministrativeFile'
    - 1.1.7.1 Invocación
  - 1.1.8 Método 'changeAdministrativeFileState'
    - 1.1.8.1 Invocación
  - 1.1.9 Método 'annulateAdminFile'
    - 1.1.9.1 Invocación
  - 1.1.10 Método 'annulateAdminFileWithReason'
    - 1.1.10.1 Invocación
- 1.2 Métodos para la gestión de índices de expedientes.
  - 1.2.1 Método 'getAdministrativeFileIndex'
    - 1.2.1.1 Invocación
  - 1.2.2 Método 'regenerateAdministrativeFileIndex'
    - 1.2.2.1 Invocación
- 1.3 Métodos para la gestión de los contenidos de los expedientes.
  - 1.3.1 Método 'addDocumentsToAdminFile'
    - 1.3.1.1 Invocación
  - 1.3.2 Método 'addAdministrativeFileToAdminFile'
    - 1.3.2.1 Invocación
  - 1.3.3 Método 'deleteDocumentFromAdminFile'
    - 1.3.3.1 Invocación
  - 1.3.4 Método 'moveDocumentToRecycleFolder'
    - 1.3.4.1 Invocación
- 1.4 Métodos para la gestión de carpetas.
  - 1.4.1 Método 'createAdministrativeFileFolder'
    - 1.4.1.1 Invocación
  - 1.4.2 Método 'deleteAdministrativeFileFolder'
    - 1.4.2.1 Invocación
  - 1.4.3 Método 'getAdministrativeFileFolder'
    - 1.4.3.1 Invocación
  - 1.4.4 Método 'moveDocumentToFolder'
    - 1.4.4.1 Invocación
  - 1.4.5 Método 'moveDocumentsToFolder'
    - 1.4.5.1 Invocación
  - 1.4.6 Método 'removeDocumentFromFolder'
    - 1.4.6.1 Invocación
  - 1.4.7 Método 'lastAddedContents'
    - 1.4.7.1 Invocación

Servicio AdministrativeFileService

A continuación se muestran todos los métodos referentes a la administración de expedientes. Los métodos que a continuación se definen permiten realizar las operaciones de apertura, recuperación, borrado de expedientes así como las operaciones necesarias para la incorporación de documentos o subexpedientes al expediente.

Métodos para la gestión de expedientes

Método 'getAdministrativeFile'

Recupera un expediente a partir del CSV u oid del mismo. Permite indicar los metadatos a devolver, si se desea recuperar todos los contenidos del expediente, si se desea recuperar el índice actual y si se desea la firma asociada al índice.

Signatura

ResultGetAdministrativeFile getAdministrativeFile(ParamGetAdministrativeFile paramGetAdministrativeFile).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción

Nombre	Tipo	Obligatorio	Descripción
ParamGetAdministrativeFile (hereda de ParamBase)
csv	String	Si(1)	CSV del expediente a consultar.
id	String	Si(1)	OID del expediente a consultar.
metadata	String[]	No(por defecto añade todos)	Array de los metadatos que se quieren recuperar.
includeIndexContent	boolean	Si	Indica si se desea recuperar el índice actual del expediente.
includeContent	boolean	Si	Indica si se desean recuperar los contenidos de los documentos del expediente.
attachIndexSignature	boolean	Si	Indica si se desea recuperar la firma asociada al índice.

NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción

Nombre	Tipo	Descripción
ResultGetAdministrativeFile (hereda de ResultError)
adminFile	AdministrativeFile	Documento con el índice y metadatos del expediente.
adminFileContents	AdministrativeFileRelation[]	Contenidos del expediente.
signatures	ArrayList<Signature>	Firmas asociadas al índice del expediente.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetAdministrativeFile

Código	Nombre	Descripción

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	No se ha especificado el id o el CSV del expediente.
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

ParamGetAdministrativeFile paramGetAdministrativeFile = new
ParamGetAdministrativeFile();
paramGetAdministrativeFile.setId("0906fca3801922bb");
paramGetAdministrativeFile.setIncludeContent(false);
paramGetAdministrativeFile.setAttachIndexSignature(false);
ResultGetAdministrativeFile result =ccsvClient.getAdministrativeFile(paramGetAdministrativeFile);
if(result.getReturnCode().equals(ReturnCode.OK){
	AdministrativeFile adminFile =result.getAdminFile();
	AdministrativeFileRelation[] adminFileContents=result.getAdminFileContents();
	ArrayList<Signature> signatures=result.getSignatures();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getAdminFileLiteAdv'

Recupera el conjunto de datos mínimo pero suficiente para la consulta de expedientes. Permite filtrar los datos a devolver; si se desean recuperar todos los agentes del expediente, si se desean recuperar los documentos del expediente, si se desean recuperar las carpetas del expediente y si se desean recuperar los subexpedientes del expediente.

Signatura

ResultGetAdministrativeFileLiteAdv getAdminFileLiteAdv(ParamGetAdministrativeFileLite paramGetAdministrativeFileLite);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción

Nombre	Tipo	Obligatorio	Descripción
ParamGetAdministrativeFileLite (hereda de ParamBase)
csv	String	Si(1)	CSV del expediente a consultar.
id	String	Si(1)	OID del expediente a consultar.
addAgents	boolean	Si	Indica si se desean recuperar los agentes del expediente.
addDocuments	boolean	Si	Indica si se desean recuperar los documentos del expediente.
addFolders	boolean	Si	Indica si se desean recuperar las carpetas del expediente.
addSubAdminFiles	boolean	Si	Indica si se desean recuperar los subexpedientes del expediente.

NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción

Nombre	Tipo	Descripción
ResultGetAdministrativeFileLiteAdv (hereda de ResultError)
administrativeFileLite	AdministrativeFileLite	Metadatos básicos del expediente.
administrativeFileDocumentAdvLiteList	Vector<AdministrativeFileDocumentLiteAdv>	Listado de documentos del expediente incluye el nombre y procedimiento del documento.
administrativeFileFolderLiteList	Vector<AdministrativeFileFolderLite>	Listado de carpetas del expediente.
administrativeFileAgentLiteList	Vector<AdministrativeFileAgentLite>	Listado de agentes del expediente.
administrativeFileLiteList	Vector<AdministrativeFileLite>	Listado de subexpedientes del expediente.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetAdministrativeFileLiteAdv

Código	Nombre	Descripción

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	No se ha especificado el id o el CSV del expediente.
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
1050	ERROR_NO_EXISTE_EXPEDIENTE	No existe ningún expediente con el código csv proporcionado
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

ParamGetAdministrativeFileLite paramGetAdministrativeFileLite = new ParamGetAdministrativeFileLite();
paramGetAdministrativeFileLite.setApplicationId("appCode");
paramGetAdministrativeFileLite.setNif("userNif");
paramGetAdministrativeFileLite.setCsv("CCSVXXXXXXXXXXCSV");
paramGetAdministrativeFileLite.setAddAgents(true);
paramGetAdministrativeFileLite.setAddDocuments(true);
paramGetAdministrativeFileLite.setAddFolders(true);
paramGetAdministrativeFileLite.setAddSubAdminFiles(true);
ResultGetAdministrativeFileLiteAdv resultGetAdministrativeFileLiteAdv = ccsvClient.getAdminFileLiteAdv(paramGetAdministrativeFileLite);

Método 'getDocumentXml'

Recupera el documento xml del expediente codificado en Base64

Signatura

ResultGetDocumentXml getDocumentXml(ParamGetDocumentXml paramGetDocumentXml).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción

Nombre	Tipo	Obligatorio	Descripción
ParamGetDocumentXml(hereda de ParamBase)
csv	String	Si(1)	CSV del expediente a consultar.
id	String	Si(1)	OID del expediente a consultar.

NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción

Nombre

Tipo

Descripción

ResultGetDocumentXml(hereda de ResultError)

base64Xml

String

Documento en xml de la respuesta codificado en base64.

id

String

Id del documento de la respuesta.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocumentXml

Código	Nombre	Descripción

Código	Nombre	Descripción
148	ERROR_DOCUMENTOS_RELACIONADOS	No se han encontrado documentos relacionados para el documento seleccionado
1042	ERROR_XML_ADMINFILE_EMPTY	El expediente debe tener contenido
1206	THREAD_ERROR	Hubo un error al generar uno o más de los documentos Eni
193	ERROR_BASEDATOS_CCSV	Error al conectar con la Base de Datos CSV
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

ParamGetDocumentXml paramGetDocumentXml = new ParamGetDocumentXml();
ParamGetDocumentXml.setCsv("CCSV54641878471CCSV");
ResultGetDocumentXml result =ccsvClient.getDocumentXml (paramGetDocumentXml);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'initializeAdministrativeFileMetadata'

Inicializa los metadatos del expediente electrónico en función de los parámetros aportados y, opcionalmente, de un documento ya existente en el gestor documental

Signatura

ResultInitializeAdministrativeFileMetadata initializeAdministrativeFileMetadata(ParamInitializeAdministrativeFileMetadata paramInitializeAdministrativeFileMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción

Nombre	Tipo	Obligatorio	Descripción
ParamInitializeAdministrativeFileMetadata(hereda de ParamBase)
applicationCode	String	Si	Código de aplicación que da de alta el expediente
applicationName	String	Si	Nombre de aplicación que da de alta el expediente
type	String	Si	Tipo del expediente
number	String	Si	Número del expediente
name	String	Si	Nombre del expediente
description	String	Si	Descripción del expediente
date	Date	Si	Fecha de apertura del expediente
procedureCode	String	No	Código de procedimiento asociado al expediente
adminFileContentCsv	String	No(1)	CSV del documento contenido en el expediente si ya existe
adminFileContentId	String	No(1)	Id del documento contenido en el expediente si ya existe

NOTA: En caso de indicar el adminFileContentCsv no habrá que indicar el adminFileContentId y viceversa.(1)

Parámetros de respuesta

Nombre	Tipo	Descripción

Nombre	Tipo	Descripción
ResultInitializeAdministrativeFileMetadata(hereda de ResultError)
adminFile	AdministrativeFile	Documento con el índice y metadatos del expediente
adminFileContents	AdministrativeFileRelation[]	Contenidos del expediente
signatures	ArrayList<Signature>	Firmas asociadas al índice del expediente

Códigos de error

Los errores de la invocación se encapsulan en ResultInitializeAdministrativeFileMetadata

Código	Nombre	Descripción

Código	Nombre	Descripción
1005	ERROR_ADMINFILE_NAMENULO	Debe especificar el parámetro name con el nombre del expediente
1006	ERROR_ADMINFILE_DESCRIPTIONNULO	Debe especificar el parámetro description con la descripción del expediente
1009	ERROR_ADMINFILE_APPLICODENULO	Debe especificar el código de aplicación
1010	ERROR_ADMINFILE_APPLINAMENULO	Debe especificar el nombre de aplicación
1011	ERROR_ADMINFILE_NUMBERNULO	Debe especificar el número del expediente
1012	ERROR_ADMINFILE_TYPERNULO	Debe especificar el tipo del expediente
1022	ERROR_ADMINFILE_DATENULO	Debe especificar la fecha de apertura del expediente
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

ParamInitializeAdministrativeFileMetadata paramInitializeAdministrativeFileMetadata = new ParamInitializeAdministrativeFileMetadata ();
paramInitializeAdministrativeFileMetadata .setApplicationCode("CodigoAplicación");
paramInitializeAdministrativeFileMetadata .setApplicationId("IdAplicacion");
paramInitializeAdministrativeFileMetadata .setApplicationName("NombreAplicación");
paramInitializeAdministrativeFileMetadata .setType("tipoExpediente");
paramInitializeAdministrativeFileMetadata .setNumber("numeroExpediente");
paramInitializeAdministrativeFileMetadata .setName("nombreExpediente");
paramInitializeAdministrativeFileMetadata .setDescription("descripción");
paramInitializeAdministrativeFileMetadata .setDate(new Date());
ResultInitializeAdministrativeFileMetadata result = ccsvClient.initializeAdminFileMetadata(paramInitializeAdminFileMetadata);
if(result.getReturnCode().equals(ReturnCode.OK){
	AdministrativeFile administrativeFile =result.getAdministrativeFile();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
/**
* Faltarían metadatos obligatorios, esto es solo un ejemplo de uso.
*/
ParamVerifyDocumentMetadata paramVerifyDocumentMetadata = new ParamVerifyDocumentMetadata();
paramVerifyDocumentMetadata.setDocument(administrativeFile);
paramVerifyDocumentMetadata.setDocumentType("EXPEDIENTE");
ResultVerifyDocumentMetadata result2 = ccsvClient.verifyDocumentMetadata (paramVerifyDocumentMetadata);
if(result2.getReturnCode().equals(ReturnCode.ERROR){
	for (int i=0;i<result2.getMetadataValueVerificationList().size();i++){
		System.out.println(result2.getMetadataValueVerificationList().get(i));
	}
}

Método 'openAdministrativeFile'

Crea un nuevo expediente en estado "Abierto" proporcionándole un documento asociado al mismo

Signatura

ResultOpenAdministrativeFile openAdministrativeFile(ParamOpenAdministrativeFile paramOpenAdministrativeFile)

Parámetros de invocación

Servicios para la gestión de expedientes

Servicio AdministrativeFileService

Métodos para la gestión de expedientes

Método 'getAdministrativeFile'

Invocación

Método 'getAdminFileLiteAdv'

Invocación

Método 'getDocumentXml'

Invocación

Método 'initializeAdministrativeFileMetadata'

Invocación

Método 'openAdministrativeFile'