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'
...
| Expand |
|---|
|
Signatura ResultRegenerateAdministrativeFileIndex regenerateAdministrativeFileIndex(ParamRegenerateAdministrativeFileIndex paramRegenerateAdministrativeFileIndex); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
ParamRegenerateAdministrativeFileIndex (hereda de ParamBase) | csv | String | Si(1) | CSV del expediente del expediente del que se va a regenerar el índice. | id | String | Si(1) | Identificador del expediente del que se va a regenerar el índice. | includeAdminFile | boolean | No(2) | Indica si se desea recuperar el objeto expediente con el índice regenerado | attachIndexSignature | boolean | No(2) | 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) NOTA 2 : Si no se indican por defecto son falsos.(2) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultRegenerateAdministrativeFileIndex |
|---|
| ResultRegenerateAdministrativeFileIndex |
|---|
|
ResultRegenerateAdministrativeFileIndex (hereda de ResultError) | adminFile | AdministrativeFile | Documento con el índice y metadatos del expediente | signatures | ArrayList<Signature> | Firmas asociadas al índice del expediente |
Códigos de error Los errores de la invocación se encapsulan en ResultRegenerateAdministrativeFileIndex 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| Code Block |
|---|
| 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'
...
| Expand |
|---|
|
Signatura ResultMoveDocumentToRecycleFolder moveDocumentToRecycleFolder(ParamMoveDocumentToRecycleFolder paramMoveDocumentToRecycleFolder); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
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 |
|---|
| Anchor |
|---|
| ResultMoveDocumentToRecycleFolder |
|---|
| ResultMoveDocumentToRecycleFolder |
|---|
|
ResultMoveDocumentToRecycleFolder(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultMoveDocumentToRecycleFolder 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| Code Block |
|---|
| 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'
...
Método 'moveDocumentToFolder'
...
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.
...