Table of Contents

Servicio IAdministrativeFileServicePortType

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'

...

Permite anular un expediente. Este método está deprecado. En su lugar hay que usar el annulateAdminFileWithReason.

Expand

title	Ver detalles

Signatura

ResultAnnulateAdminFile annulateAdminFile(ParamAnnulateAdminFile param);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamAnnulateAdminFile (hereda de ParamBase)
csv	String	Si	CSV del expediente a anular.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultAnnulateAdminFile (hereda de ResultError)

Códigos de error

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

Code Block

language	java

ParamAnnulateAdminFile paramAnnulateAdminFile = new ParamAnnulateAdminFile();
paramAnnulateAdminFile.setApplicationId("appCode");
paramAnnulateAdminFile.setAdminFileCsv("CCSVXXXXXXXXXXCSV");
ResultAnnulateAdminFile resultAnnulateAdminFile = ccsvClient.annulateAdminFile(paramAnnulateAdminFile);

Método 'annulateAdminFileWithReason'

...

Permite anular un expediente añadiendo un motivo.

Expand

title	Ver detalles

Signatura

ResultAnnulateAdminFileWithReason annulateAdminFileWithReason(ParamAnnulateAdminFileWithReason param);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
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
ResultAnnulateAdminFileWithReason (hereda de ResultError)

Códigos de error

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

Code Block

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.

...

Expand

title	Ver detalles

Signatura

ResultGetAdministrativeFileIndex getAdministrativeFileIndex(ParamGetAdministrativeFileIndex paramGetAdministrativeFileIndex);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
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

Anchor

	ResultGetAdministrativeFileIndex
	ResultGetAdministrativeFileIndex

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
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

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

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

language	java

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

title	Ver detalles

Signatura

ResultAddDocumentsToAdminFile addDocumentsToAdminFile(ParamAddDocumentsToAdminFile paramAddDocumentsToAdminFile);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripció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

Anchor

	ResultAddDocumentsToAdminFile
	ResultAddDocumentsToAdminFile

ResultAddDocumentsToAdminFile(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultAddDocumentsToAdminFile

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

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultAddAdministrativeFileToAdminFile addAdministrativeFileToAdminFile(ParamAddAdministrativeFileToAdminFile paramAddAdministrativeFileToAdminFile);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
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

Anchor

	ResultAddAdministrativeFileToAdminFile
	ResultAddAdministrativeFileToAdminFile

ResultAddAdministrativeFileToAdminFile (hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultAddAdministrativeFileToAdminFile

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

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultDeleteDocumentFromAdminFile deleteDocumentFromAdminFile(ParamDeleteDocumentFromAdminFile paramDeleteDocumentFromAdminFile );

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
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

Anchor

	ResultDeleteDocumentFromAdminFile
	ResultDeleteDocumentFromAdminFile

ResultDeleteDocumentFromAdminFile (hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultDeleteDocumentFromAdminFile

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

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

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

language	java

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'

...

Expand

title	Ver detalles

Signatura

ResultCreateAdministrativeFileFolder createAdministrativeFileFolder(ParamCreateAdministrativeFileFolder paramCreateAdministrativeFileFolder);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamCreateAdministrativeFileFolder (hereda de ParamBase)
csv	String	Si(1)	CSV del expediente.
id	String	Si(1)	Identificador del expediente.
adminFileFolder	AdministrativeFileFolder	Si(2)	Carpeta que se desea crear.

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

Anchor

	ResultCreateAdministrativeFileFolder
	ResultCreateAdministrativeFileFolder

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
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

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultDeleteAdministrativeFileFolder deleteAdministrativeFileFolder(ParamDeleteAdministrativeFileFolder paramDeleteAdministrativeFileFolder);

Parámetros de invocación

Nombre	Tipo	Descripción
ParamDeleteAdministrativeFileFolder (hereda de ParamBase)
csv	String(1)	CSV del expediente.
id	String(1)	Identificador del expediente.
adminFileFolderCode	String(2)	Código de la carpeta que se desea eliminar
adminFileFolderId	String(2)	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 adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultDeleteAdministrativeFileFolder
	ResultDeleteAdministrativeFileFolder

ResultDeleteAdministrativeFileFolder(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultDeleteAdministrativeFileFolder

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
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
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block

language	java

ParamDeleteAdministrativeFileFolder paramDeleteAdministrativeFileFolder = new ParamDeleteAdministrativeFileFolder();
paramDeleteAdministrativeFileFolder.setCsv("CCSV54641878471CCSV");
paramDeleteAdministrativeFileFolder.setAdminFileFolderId("095464654564j");
ResultDeleteAdministrativeFileFolder result = ccsvClient.deleteAdministrativeFileFolder(paramDeleteAdministrativeFileFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+”:”+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultGetAdministrativeFileFolder getAdministrativeFileFolder(ParamGetAdministrativeFileFolder paramGetAdministrativeFileFolder);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
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

Anchor

	ResultGetAdministrativeFileFolder
	ResultGetAdministrativeFileFolder

ResultGetAdministrativeFileFolder(hereda de ResultError)

adminFileFolder

AdministrativeFileFolder

Carpeta del expediente

folderContents

AdministrativeFileRelation[]

Contenidos de la carpeta

Códigos de error

Los errores de la invocación se encapsulan en ResultGetAdministrativeFileFolder

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
1028	ERROR_NOTEXIST_FOLDERINADMINFILE	No existe esa carpeta 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

language	java

ParamGetAdministrativeFileFolder paramGetAdministrativeFileFolder = new ParamGetAdministrativeFileFolder();
paramGetAdministrativeFileFolder.setCsv("CCSV54641878471CCSV");
paramGetAdministrativeFileFolder.setAdminFileFolderId("095464654564j");
paramGetAdministrativeFileFolder.setIncludeContent(true);
ResultGetAdministrativeFileFolder result = ccsvClient.getAdministrativeFileFolder(paramGetAdministrativeFileFolder);
if(result.getReturnCode().equals(ReturnCode.OK){
	AdministrativeFileFolder adminFileFolder = result.getAdminFileFolder();
	AdministrativeFileRelation[] folderContents = result.getFolderContents();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultMoveDocumentToFolder moveDocumentToFolder(ParamMoveDocumentToFolder paramMoveDocumentToFolder);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamMoveDocumentToFolder(hereda de ParamBase)
csv	String	Si(1)	CSV del expediente.
id	String	Si(1)	Identificador del expediente.
contentCsv	String	Si(2)	CSV del documento que se va a mover
contentId	String	Si(2)	Identificador del documento que se va a mover
adminFileFolderCode	String	Si(3)	Código de la carpeta a la que se desea mover el documento
adminFileFolderId	String	Si(3)	Identificador de la carpeta a la que se desea mover 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 campo adminFileFolderId y viceversa.(3)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultMoveDocumentToFolder
	ResultMoveDocumentToFolder

ResultMoveDocumentToFolder(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultMoveDocumentToFolder

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

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultMoveDocumentsToFolder moveDocumentsToFolder(ParamMoveDocumentsToFolder paramMoveDocumentsToFolder);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamMoveDocumentsToFolder (hereda de ParamBase)
csv	String	Si(1)	CSV del expediente.
id	String	Si(1)	Identificador del expediente.
contentsCsv	String[]	Si(2)	Lista de CSV's de los documentos que se va a mover
contentsId	String[]	Si(2)	Lista de Identificadores de los documentos que se va a mover
adminFileFolderCode	String	Si(3)	Código de la carpeta a la que se desea mover el documento
adminFileFolderId	String	Si(3)	Identificador de la carpeta a la que se desea mover el documento

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 campo contentsId y viceversa.(2)

NOTA 3:Si se rellena el adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa.(3)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultMoveDocumentsToFolder
	ResultMoveDocumentsToFolder

ResultMoveDocumentsToFolder(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultMoveDocumentsToFolder

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
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
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

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultRemoveDocumentFromFolder removeDocumentFromFolder(ParamRemoveDocumentFromFolder paramRemoveDocumentFromFolder);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamRemoveDocumentFromFolder (hereda de ParamBase)
csv	String	Si(1)	CSV del expediente.
id	String	Si(1)	Identificador del expediente.
contentsCsv	String[]	Si(2)	CSV del documento que se va a eliminar
contentsId	String[]	Si(2)	Identificador del documento que se va eliminar
adminFileFolderCode	String	Si(3)	Código de la carpeta de la que se desea quitar el documento
adminFileFolderId	String	Si(3)	Identificador de la carpeta de la que se desea quitar el documento

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 campo contentsId y viceversa.(2)

NOTA 3:Si se rellena el adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa.(3)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultRemoveDocumentFromFolder
	ResultRemoveDocumentFromFolder

ResultRemoveDocumentFromFolder (hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultRemoveDocumentFromFolder

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
1027	ERROR_NOTEXIST_DOCINFOLDER	No existe ese documento en la carpeta especificada
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block

language	java

ParamRemoveDocumentFromFolder paramRemoveDocumentFromFolder = new ParamRemoveDocumentFromFolder();
paramRemoveDocumentFromFolder.setCsv("CCSV54641878471CCSV");
paramRemoveDocumentFromFolder.setContentCsv("CCSV1984991484CCSV");
paramRemoveDocumentFromFolder.setAdminFileFolderId("095464654564j");
ResultRemoveDocumentFromFolder result = ccsvClient.removeDocumentFromFolder (paramRemoveDocumentFromFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultLastAddedContents lastAddedContents(ParamLastAddedContents paramLastAddedContents);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción
ParamLastAddedContents (hereda de ParamBase)
csv	String	Si(1)	CSV del expediente.
id	String	Si(1)	Identificador del expediente.
dateStart	Date	No	Devolverá expedientes, documentos y carpetas, añadidos a partir de esa fecha
metadata	String[]	No	Array de nombres de los metadatos que deseamos recuperar
includeContent	boolean	No	Indica si se desean recuperar los contenidos de los documentos del expediente

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

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultLastAddedContents
	ResultLastAddedContents

ResultLastAddedContents (hereda de ResultError)

contents

Object[]

Devuelve los últimos objetos que se han añadido puede ser un Document, AdministrativeFileFolder o AdministrativeFile

Códigos de error

Los errores de la invocación se encapsulan en ResultLastAddedContents

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

Code Block

language	java

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());
}

...

Versions Compared

Old Version 29

New Version 30

Key

Servicio IAdministrativeFileServicePortType

Métodos para la gestión de expedientes

Método 'getAdministrativeFile'

Invocación

Método 'annulateAdminFileWithReason'

Invocación

Métodos para la gestión de índices de expedientes.

Invocación

Invocación

Métodos para la gestión de los contenidos de los expedientes.

Método 'addDocumentsToAdminFile'

Invocación

Invocación

Invocación

Invocación

Métodos para la gestión de carpetas.

Método 'createAdministrativeFileFolder'

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Page Comparison

Versions Compared

Old Version 29

New Version 30

Key

Servicio IAdministrativeFileServicePortType

Métodos para la gestión de expedientes

Método 'getAdministrativeFile'

Invocación

Método 'annulateAdminFileWithReason'

Invocación

Métodos para la gestión de índices de expedientes.

Invocación

Invocación

Métodos para la gestión de los contenidos de los expedientes.

Método 'addDocumentsToAdminFile'

Invocación

Invocación

Invocación

Invocación

Métodos para la gestión de carpetas.

Método 'createAdministrativeFileFolder'

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación