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.
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.
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
CSV del documento contenido en el expediente si ya existe
adminFileContentId
String
(2)
Id del documento contenido en el expediente si ya existe
createAdminFileContent
boolean
Si
Indica si el documento contenido en el expediente existe o hay que crearlo
NOTA : si createAdminFileContent es true signedDocument será obligatorio (1) ,en caso de ser falso habrá que indicar o el Csv o el id en documentum(2)
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultOpenAdministrativeFile(hereda de ResultError)
id
String
Identificador en Documentum del expediente creado.
adminFileContentId
String
Identificador en Documentum del documento contenido creado.
Códigos de error
Los errores de la invocación se encapsulan en ResultOpenAdministrativeFile
Código
Nombre
Descripción
Código
Nombre
Descripción
1021
ERROR_ADMINFILENULO
Debe especificar el adminFile con todos los datos del expediente.
1003
ERROR_ADMINFILE_CSVNULO
Debe especificar el valor del CSV del expediente
1005
ERROR_ADMINFILE_NAMENULO
Debe especificar el parámetro name con el nombre del expediente
1007
ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS
Debe especificar el id o el CSV del documento contenido del expediente
1008
ERROR_ADMINFILE_DOC_CONTENIDO_NULO
Debe especificar un documento contenido y su firma
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
1019
ERROR_ADMINFILE_OPENORIGINALCOPIA
No se puede abrir un expediente con un documento que no esté en estado Original o Copia
1002
ERROR_DOCUMENTMETADATA
Error del DocumentMetadataManager
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
ParamOpenAdministrativeFile paramOpenAdministrativeFile = new ParamOpenAdministrativeFile();
//adminFile es un AdministrativeFile inicializado y ya con todos los datos.
paramOpenAdministrativeFile.setAdminFile(adminFile);
paramOpenAdministrativeFile.setCreateAdminFileContent(false);
paramOpenAdministrativeFile.setAdminFileContentCsv("CSV25754872574CCSV");
ResultOpenAdministrativeFile result =ccsvClient.openAdministrativeFile(paramOpenAdministrativeFile);
if(result.getReturnCode().equals(ReturnCode.OK){
String id =result.getId();
String adminFileContentId =result.getAdminFileContentId();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'closeAdministrativeFile'
Pasa el expediente a estado "Cerrado". En caso de contener subexpedientes también realiza el cerrado de los mismos.
ParamReopenAdministrativeFile(hereda de ParamBase)
csv
String
Si(1)
CSV del expediente del expediente a reabrir.
id
String
Si(1)
Identificador del expediente a reabrir.
date
Date
No
Fecha de reapertura del expediente.
NOTA: Si se consulta por csv no se rellena el campo id y viceversa.
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultReopenAdministrativeFile(hereda de ResultError)
Códigos de error
Los errores de la invocación se encapsulan en ResultReopenAdministrativeFile
Código
Nombre
Descripción
Código
Nombre
Descripción
1017
ERROR_ADMINFILE_CSV_E_ID_NULOS
Debe especificar el id o el CSV del expediente
104
ERROR_REEMPLAZAR_PAPIRO
[PAPIRO] Error al intentar reemplazar el documento.
1002
ERROR_DOCUMENTMETADATA
Error del DocumentMetadataManager
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
ParamReopenAdministrativeFile paramReopenAdministrativeFile = new ParamReopenAdministrativeFile();
paramReopenAdministrativeFile.setCsv("CCSV54641878471CCSV");
paramReopenAdministrativeFile.setDate(new Date());
ResultReopenAdministrativeFile result = ccsvClient.reopenAdministrativeFile(paramReopenAdministrativeFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'changeAdministrativeFileState'
Permite cambiar el estado del expediente actuando sobre el metadato expediente_estado. Los cambios posibles serán:
De Abierto a Cerrado
De Abierto a Índice para Remisión Cerrado.
NOTA: Se puede cambiar el estado de un expediente de abierto a cerrado. También se puede pasar al estado Índice para Remisión Cerrado. ¿Qué implica este cambio de pasar a Índice para Remisión Cerrado en el expediente? Este estado fue definido en la resolución del BOE https://www.boe.es/buscar/doc.php?id=BOE-A-2011-13170 como una de los posibles opciones en el esquema de valores para el estado de un expediente en el momento del intercambio y su definición seria “Estado cuando se intercambia un expediente y en ese momento se cierra el índice para garantizar que los documentos que se mandan asociados a dicho expediente son los de ese índice en concreto”. Actualmente no se esta haciendo uso de este estado.
ParamAnnulateAdminFileWithReason (hereda de ParamBase)
adminFileCsv
String
Si
CSV del expediente a anular.
reason
String
No
Motivo de la anulacion del expediente.
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultAnnulateAdminFileWithReason(hereda de ResultError)
Códigos de error
Código
Nombre
Descripción
Código
Nombre
Descripción
127
ERROR_CSV_NOEXISTE
No existe documento con el CSV especificado
1044
ERROR_IS_NOT_ADMINFILE
El documento no es un expediente administrativo.
1045
ERROR_ADMINFILE_CLOSED
El expediente administrativo no se encuentra abierto.
1046
ERROR_ADMINFILE_ANNULATED
El expediente administrativo se encuentra ANULADO y no puede ser modificado.
130
ERROR_BASEDATOS_CSVPAPIRO
Error al conectar con la base de datos CCSV
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
ParamAnnulateAdminFileWithReason paramAnnulateAdminFileWithReason = new ParamAnnulateAdminFileWithReason();
paramAnnulateAdminFileWithReason.setApplicationId("appCode");
paramAnnulateAdminFileWithReason.setAdminFileCsv("CCSVXXXXXXXXXXCSV");
paramAnnulateAdminFileWithReason.setReason("Motivo de la anulación");
ResultAnnulateAdminFileWithReason resultAnnulateAdminFileWithReason = ccsvClient.annulateAdminFileWithReason(paramAnnulateAdminFileWithReason);
Métodos para la gestión de índices de expedientes.
ParamGetAdministrativeFileIndex (hereda de ParamBase)
csv
String
Si(1)
CSV del índice del expediente a consultar.
id
String
Si(1)
Identificador del índice 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
ResultGetAdministrativeFileIndex(hereda de ResultError)
content
DataHandler
Contenido del índice electrónico del expediente electrónico administrativo
Códigos de error
Los errores de la invocación se encapsulan en ResultGetAdministrativeFileIndex
Código
Nombre
Descripción
Código
Nombre
Descripción
1017
ERROR_ADMINFILE_CSV_E_ID_NULOS
Debe especificar el id o el CSV del expediente
1034
ERROR_ADMINFILE_STATENULO
El índice del expediente solicitado está pendiente de regenerarse
1002
ERROR_DOCUMENTMETADATA
Error del DocumentMetadataManager
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
ParamGetAdministrativeFileIndex paramGetAdministrativeFileIndex = new ParamGetAdministrativeFileIndex();
paramGetAdministrativeFileIndex.setId("0906fca3801922bb");
ResultGetAdministrativeFileIndex result = ccsvClient.getAdministrativeFileIndex(paramGetAdministrativeFileIndex);
if(result.getReturnCode().equals(ReturnCode.OK){
DataHandler content = result.getContent();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'regenerateAdministrativeFileIndex'
Regenera el índice del expediente dejando el índice antiguo en un documento aparte con relación con rol: "ES VERSIÓN DE". Recuperando si se indica en los parámetros, el objeto expediente con el índice regenerado o su firma.
Los errores de la invocación se encapsulan en ResultRegenerateAdministrativeFileIndex
Código
Nombre
Descripción
Código
Nombre
Descripción
1002
ERROR_DOCUMENTMETADATA
Error del DocumentMetadataManager
801
GENERIC_ERROR
Error genérico procesando la petición.
1019
ERROR_ADMINFILE_OPENORIGINALCOPIA
El expediente carece de contenido por lo que no se puede generar el índice.
Ejemplo de invocación
Invocación
ParamRegenerateAdministrativeFileIndex paramRegenerateAdministrativeFileIndex = new ParamRegenerateAdministrativeFileIndex();
paramRegenerateAdministrativeFileIndex.setId("0906fca3801922bb");
paramRegenerateAdministrativeFileIndex.setIncludeAdminFile(true);
ResultRegenerateAdministrativeFileIndex result = ccsvClient.regenerateAdministrativeFileIndex(paramRegenerateAdministrativeFileIndex);
if(result.getReturnCode().equals(ReturnCode.OK){
AdministrativeFile adminFile = result.getAdminFile();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Métodos para la gestión de los contenidos de los expedientes.
Método 'addDocumentsToAdminFile'
Incluye la lista de documentos existentes en el gestor documental a un expediente en estado "Abierto". Si este expediente tiene carpetas puede identificarse esta para incluirlos dentro y no en la raíz del expediente. Nota: Si se quiere incluir un documento de registro, se deberá subir a la vez, todos los documentos que tenga la relación REGISTRA y/o ADJUNTA. El resultado de incluir uno o varios documentos a un expediente, crea una relación CONTIENE entre el expediente y dichos documentos. Será necesario una vez incluidos, regenerar el índice del expediente para su actualización.
ParamAddDocumentsToAdminFile (hereda de ParamBase)
csv
String
Si(1)
CSV del expediente donde se va a añadir el documento.
id
String
Si(1)
Identificador del expediente donde se va a añadir el documento.
contentsCsv
String[]
Si(2)
Array de CSV's de los documentos a añadir.
contentsId
String[]
Si(2)
Array de Identificadores de los documentos a añadir.
adminFileFolderCode
String
No(3)
Código de la carpeta donde incluir el documento.
adminFileFolderId
String
No(3)
Identificador de la carpeta donde incluir el documento.
organismCode
String
No
Código del organismo que se añadirá como gestor.
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)
NOTA 2: Si se rellena el contentsCsv no se rellena el contentsId y viceversa.(2)
NOTA 3: Si se rellena el adminFileFolderCode no se rellena el adminFileFolderId y viceversa.(3)
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultAddDocumentsToAdminFile(hereda de ResultError)
Códigos de error
Los errores de la invocación se encapsulan en ResultAddDocumentsToAdminFile
Código
Nombre
Descripción
Código
Nombre
Descripción
1017
ERROR_ADMINFILE_CSV_E_ID_NULOS
Debe especificar el id o el CSV del expediente.
1014
ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_NULOS
Debe especificar contentsId o contentsCsv de los documentos que contiene el expediente.
1015
ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_DUP
Sólo debe especificar o contentsId o contentsCsv con los documentos que contiene el expediente.
1028
ERROR_NOTEXIST_FOLDERINADMINFILE
No existe esa carpeta en el expediente especificado.
1001
ERROR_OPEN_STATE
No se puede modificar la estructura de un expediente que no esté en estado Abierto.
1002
ERROR_DOCUMENTMETADATA
Error del DocumentMetadataManager.
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
ParamAddDocumentsToAdminFile paramAddDocumentsToAdminFile = new ParamAddDocumentsToAdminFile();
// añadimos 2 documentos ya existentes identificados por su id en una carpeta de un expediente
paramAddDocumentsToAdminFile.setId("0906fca3801922bb");
String[] ids = {"0907lca3801958jk", "0907lca3587459jk"}
paramAddDocumentsToAdminFile.setContentsId(ids);
paramAddDocumentsToAdminFile.setAdminFileFolderCode("codigoCarpeta");
ResultAddDocumentsToAdminFile result = ccsvClient.addDocumentsToAdminFile(paramAddDocumentsToAdminFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'addAdministrativeFileToAdminFile'
Añade el expediente existente en el gestor documental a un expediente en estado "Abierto". Para ello se deberá crear una relación entre el expediente y el subexpediente con rol "CONTIENE". Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.
ParamAddAdministrativeFileToAdminFile(hereda de ParamBase)
csv
String
Si(1)
CSV del expediente donde se va a añadir el documento.
id
String
Si(1)
Identificador del expediente donde se va a añadir el documento.
contentCsv
String
Si(2)
CSV del expediente a añadir
contentId
String
Si(2)
Identificador del expediente a añadir
adminFileFolderCode
String
No(3)
Código de la carpeta donde incluir el documento.
adminFileFolderId
String
No(3)
Identificador de la carpeta donde incluir el documento.
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)
NOTA 2: Si se rellena el contentCsv no se rellena el campo contentId y viceversa.(2)
NOTA 3: Si se rellena el adminFileFolderCode no se rellena el adminFileFolderId y viceversa.(3)
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultAddAdministrativeFileToAdminFile (hereda de ResultError)
Códigos de error
Los errores de la invocación se encapsulan en ResultAddAdministrativeFileToAdminFile
Código
Nombre
Descripción
Código
Nombre
Descripción
1017
ERROR_ADMINFILE_CSV_E_ID_NULOS
Debe especificar el id o el CSV del expediente.
1007
ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_NULOS
Debe especificar el id o el CSV del documento contenido del expediente
1028
ERROR_NOTEXIST_FOLDERINADMINFILE
No existe esa carpeta en el expediente especificado.
1001
ERROR_OPEN_STATE
No se puede modificar la estructura de un expediente que no esté en estado Abierto.
1002
ERROR_DOCUMENTMETADATA
Error del DocumentMetadataManager.
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
ParamAddAdministrativeFileToAdminFile paramAddAdministrativeFileToAdminFile = new ParamAddAdministrativeFileToAdminFile();
paramAddAdministrativeFileToAdminFile.setId("09587425558554jk");
paramAddAdministrativeFileToAdminFile.setContentId("098745255456654rr");
ResultAddAdministrativeFileToAdminFile result = ccsvClient.AddAdministrativeFileToAdminFile(paramAddAdministrativeFileToAdminFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'deleteDocumentFromAdminFile'
Quita un documento de un expediente en estado "Abierto". Para ello elimina la relación entre el expediente y el documento con rol "CONTIENE". No borra el documento de CCSV.
ParamDeleteDocumentFromAdminFile (hereda de ParamBase)
csv
String
Si(1)
CSV del expediente donde se va a buscar el documento a borrar.
id
String
Si(1)
Identificador del expediente donde se va a buscar el documento a borrar.
contentCsv
String
Si(2)
CSV del documento a borrar.
contentId
String
Si(2)
Identificador del documento a borrar.
adminFileFolderId
String
No
Identificador de la carpeta que se desea eliminar.
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)
NOTA 2: Si se rellena el contentCsv no se rellena el campo contentId y viceversa.(2)
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultDeleteDocumentFromAdminFile(hereda de ResultError)
Códigos de error
Los errores de la invocación se encapsulan en ResultDeleteDocumentFromAdminFile
Código
Nombre
Descripción
Código
Nombre
Descripción
1017
ERROR_ADMINFILE_CSV_E_ID_NULOS
Debe especificar el id o el CSV del expediente.
1018
ERROR_STATEORIGINALCOPIA
No se puede borrar del expediente documentos en estado Original o Copia
1007
ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS
Debe especificar el id o el CSV del documento contenido del expediente
1001
ERROR_OPEN_STATE
No se puede modificar la estructura de un expediente que no esté en estado Abierto.
1029
ERROR_NOTEXIST_DOCINADMINFILE
No existe ese documento en el expediente especificado
1002
ERROR_DOCUMENTMETADATA
Error del DocumentMetadataManager.
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
ParamDeleteDocumentFromAdminFile paramDeleteDocumentFromAdminFile = new ParamDeleteDocumentFromAdminFile();
paramDeleteDocumentFromAdminFile.setId("0925745454564gf");
paramDeleteDocumentFromAdminFile.setContentId("09254654446586ff");
ResultDeleteDocumentFromAdminFile result = ccsvClient.deleteDocumentFromAdminFile(paramDeleteDocumentFromAdminFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'moveDocumentToRecycleFolder'
Servicio que elimina la relación entre un documento en cualquier estado y un expediente abierto, moviendo físicamente el documento a la carpeta dmFolder de “Papelera de reciclaje”. Si el documento se encuentra dentro de una carpeta en el expediente también eliminará la relación. El documento puede estar en cualquier estado. Se añadirá el expediente a la lista de expedientes pendientes de regeneración de su índice por el proceso nocturno.
ParamMoveDocumentToRecycleFolder(hereda de ParamBase)
adminFileCsv
String
Si(1)
csv del expediente donde se encuentra el documento a mover, en caso de que el documento esté directamente en el expediente.
adminFileId
String
Si(1)
Identificador en Documentum del expediente donde se encuentra el documento a mover, en caso de que el documento esté directamente en el expediente.
documentCsv
String
Si(2)
csv del documento a mover.
documentId
String
Si(2)
Identificador en Documentum del documento a mover.
reasonToMove
String
Si
Razón por la que se solicita el movimiento a la papelera de reciclaje.
NOTA: Si se rellena el adminFileCsv no se rellena el campo adminFileId y viceversa.(1)
NOTA 2: Si se rellena el documentCsv no se rellena el campo documentId y viceversa.(2)
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultMoveDocumentToRecycleFolder(hereda de ResultError)
Códigos de error
Los errores de la invocación se encapsulan en ResultMoveDocumentToRecycleFolder
Código
Nombre
Descripción
Código
Nombre
Descripción
1017
ERROR_ADMINFILE_CSV_E_ID_NULOS
Debe especificar el id o el CSV del expediente.
1039
ERROR_ADMINFILE_NIF_USER_REQUESTING_MOVE_NULL
El NIF del usuario que solicita el movimiento es obligatorio
1007
ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS
Debe especificar el id o el CSV del documento contenido del expediente
1040
ERROR_ADMINFILE_REASON_TO_MOVE_NULL
La razón por la que solicita el movimiento es obligatoria
1029
ERROR_NOTEXIST_DOCINADMINFILE
No existe ese documento en el expediente especificado
1002
ERROR_DOCUMENTMETADATA
Error del DocumentMetadataManager.
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
ParamMoveDocumentToRecycleFolder paramMoveDocumentToRecycleFolder = new ParamMoveDocumentToRecycleFolder();
paramMoveDocumentToRecycleFolder.setAdminFileCsv("CCSV54641878471CCSV");
paramMoveDocumentToRecycleFolder.setNif("00000000T");
ResultMoveDocumentToRecycleFolder result = ccsvClient.moveDocumentToRecycleFolder(paramMoveDocMétodos para la gestión de carpetas.umentToRecycleFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Métodos para la gestión de carpetas.
Método 'createAdministrativeFileFolder'
Crea una carpeta dentro del expediente, para ello habrá que relacionar el expediente con la carpeta con una relación con rol CONTIENE". Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1)
NOTA 2: Necesitaremos el code y el name del AdminFileFolder que queremos crear..(2)
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultCreateAdministrativeFileFolder (hereda de ResultError)
adminFileFolderId
String
Identificador de la carpeta que se ha creado.
Códigos de error
Los errores de la invocación se encapsulan en ResultCreateAdministrativeFileFolder
Código
Nombre
Descripción
Código
Nombre
Descripción
1017
ERROR_ADMINFILE_CSV_E_ID_NULOS
Debe especificar el id o el CSV del expediente.
1030
ERROR_ADMINFILEFOLDER_CREATE
Faltan datos de la carpeta que se desea crear
1001
ERROR_OPEN_STATE
No se puede modificar la estructura de un expediente que no esté en estado Abierto
1035
ERROR_ADMINFILEFOLDER_CREATE_CODE
El código de la carpeta no puede tener más de 20 caracteres
1036
ERROR_ADMINFILEFOLDER_CREATE_NAME
El nombre de la carpeta no puede tener más de 80 caracteres
1002
ERROR_DOCUMENTMETADATA
Error del DocumentMetadataManager.
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
ParamCreateAdministrativeFileFolder paramCreateAdministrativeFileFolder = new ParamCreateAdministrativeFileFolder();
// adminFileFolder es un objeto de la clase AdminFileFolder que contiene el code y el name de la carpeta que queremos crear.
paramCreateAdministrativeFileFolder.setAdminFileFolder(adminFileFolder);
paramCreateAdministrativeFileFolder.setId("09254644654456hk");
ResultCreateAdministrativeFileFolder result = ccsvClient.createAdministrativeFileFolder(paramCreateAdministrativeFileFolder);
if(result.getReturnCode().equals(ReturnCode.OK){
String adminFileFolderId = result.getAdminFileFolderId();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
Método 'deleteAdministrativeFileFolder'
Elimina una carpeta dentro del expediente. Deberá mover las relaciones con los documentos contenidos en la carpeta directamente sobre el expediente. Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.
ParamGetAdministrativeFileFolder (hereda de ParamBase)
csv
String
Si(1)
CSV del expediente.
id
String
Si(1)
Identificador del expediente.
adminFileFolderCode
String
Si(2)
Código de la carpeta que se desea eliminar
adminFileFolderId
String
Si(2)
Identificador de la carpeta que se desea eliminar
metadata
String[]
No(3)
Lista de atributos que se desean recuperar de los documentos de la carpeta
includeContent
boolean
Si
Indica se se desean recuperar los contenidos de los documentos de la carpeta
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.
NOTA 2: Si se rellena el adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa.
NOTA 3:Por defecto añade los metadatos: código de la carpeta, nombre de la carpeta, descripción tipo documento, CSV, estado del documento, fecha captura, estado del expediente, fecha apertura del expediente y número de expediente.(3)
Parámetros de respuesta
Nombre
Tipo
Descripción
Nombre
Tipo
Descripción
ResultGetAdministrativeFileFolder(hereda de ResultError)
NOTA: Se recomienda el uso del método moveDocumentsToFolder por motivos de eficiencia.
Mueve un documento a una carpeta especificada. Si ya está dentro de una carpeta, se deberá cambiar la relación "CONTIENE" a la nueva carpeta conservando la fecha que es la de incorporación del documento al expediente. Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.
Los errores de la invocación se encapsulan en ResultMoveDocumentToFolder
Código
Nombre
Descripción
Código
Nombre
Descripción
1017
ERROR_ADMINFILE_CSV_E_ID_NULOS
Debe especificar el id o el CSV del expediente.
1031
ERROR_ADMINFILEFOLDER_CREATE
Faltan datos de la carpeta que se desea crear
1007
ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS
Debe especificar el id o el CSV del documento contenido del expediente
1001
ERROR_OPEN_STATE
No se puede modificar la estructura de un expediente que no esté en estado Abierto
1028
ERROR_NOTEXIST_FOLDERINADMINFILE
No existe esa carpeta en el expediente especificado
1029
ERROR_NOTEXIST_DOCINADMINFILE
No existe ese documento en el expediente especificado
1002
ERROR_DOCUMENTMETADATA
Error del DocumentMetadataManager.
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
ParamMoveDocumentToFolder paramMoveDocumentToFolder = new ParamMoveDocumentToFolder();
paramMoveDocumentToFolder.setCsv("CCSV54641878471CCSV");
paramMoveDocumentToFolder.setContentCsv("CCSV54646484849CCSV");
paramMoveDocumentToFolder.setAdminFileFolderId("095464654564j");
ResultMoveDocumentToFolder result = ccsvClient.moveDocumentToFolder(paramMoveDocumentToFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+”:”+result.getErrorMessage());
}
Método 'moveDocumentsToFolder'
Mueve un grupo de documentos a una carpeta especificada. Si ya está dentro de una carpeta, se deberá cambiar la relación "CONTIENE" a la nueva carpeta conservando la fecha que es la de incorporación del documento al expediente. Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.
Debe especificar contentsId o contentsCsv de los documentos que contiene el expediente
1015
ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_DUP
Sólo debe especificar o contentsId o contentsCsv con los documentos que contiene el expediente
1001
ERROR_OPEN_STATE
No se puede modificar la estructura de un expediente que no esté en estado Abierto
1028
ERROR_NOTEXIST_FOLDERINADMINFILE
No existe esa carpeta en el expediente especificado
1029
ERROR_NOTEXIST_DOCINADMINFILE
No existe ese documento en el expediente especificado
1002
ERROR_DOCUMENTMETADATA
Error del DocumentMetadataManager.
801
GENERIC_ERROR
Error genérico procesando la petición.
Ejemplo de invocación
Invocación
ParamMoveDocumentsToFolder paramMoveDocumentsToFolder = new ParamMoveDocumentsToFolder();
paramMoveDocumentsToFolder.setCsv("CCSV54641878471CCSV");
// contentsCsv es un String[] que contiene los csv's de los documentos que queremos mover
paramMoveDocumentsToFolder.setContentsCsv(contentsCsv);
paramMoveDocumentsToFolder.setAdminFileFolderId("095464654564j");
ResultMoveDocumentsToFolder result =ccsvClient.moveDocumentsToFolder(paramMoveDocumentsToFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+”:”+result.getErrorMessage());
}
Método 'removeDocumentFromFolder'
Mueve un documento de una carpeta a la raíz del expediente, cambiando la relación "CONTIENE" al expediente. Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.
Los errores de la invocación se encapsulan en ResultLastAddedContents
Código
Nombre
Descripción
Código
Nombre
Descripción
1017
ERROR_ADMINFILE_CSV_E_ID_NULOS
Debe especificar 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
ParamLastAddedContents paramLastAddedContents = new ParamLastAddedContents();
paramLastAddedContents.setApplicationId("CCSV");
paramLastAddedContents.setDateStart(Calendar.getInstance().getTime());//fecha desde la que se desean recoger los datos.
paramLastAddedContents.setIncludeContent(true);
paramLastAddedContents.setNif("00000000T");
ResultLastAddedContents result = ccsvClient.lastAddedContents(paramLastAddedContents);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
