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'

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.

Ver detalles

Signatura

ResultGetAdministrativeFile getAdministrativeFile(ParamGetAdministrativeFile paramGetAdministrativeFile).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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
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
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 'getAdminFileLite'

Recupera el conjunto de datos mínimo pero suficiente para la consulta de expedientes. Permite indicar 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.

Ver detalles

Signatura

ResultGetAdministrativeFileLite getAdminFileLite(ParamGetAdministrativeFileLite paramGetAdministrativeFileLite);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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
ResultGetAdministrativeFileLite (hereda de ResultError)
administrativeFileLite	AdministrativeFileLite	Metadatos básicos del expediente.
administrativeFileDocumentLiteList	Vector<AdministrativeFileDocumentLite>	Listado de documentos del expediente.
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 ResultGetAdministrativeFile

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

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);
ResultGetAdministrativeFileLite resultGetAdministrativeFileLite = ccsvClient.getAdminFileLite(paramGetAdministrativeFileLite);

Método 'getAdminFileLiteAdv'

Similar al método getAdminFileLite pero tambien recupera el nombre y numero de procedimiento de los documentos.

Ver detalles

Signatura

ResultGetAdministrativeFileLiteAdv getAdminFileLite(ParamGetAdministrativeFileLite paramGetAdministrativeFileLite);

Parámetros de invocación

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

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

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);
ResultGetAdministrativeFileLite resultGetAdministrativeFileLite = ccsvClient.getAdminFileLite(paramGetAdministrativeFileLite);

Método 'getDocumentXml'

Recupera el documento xml del expediente codificado en Base64

Ver detalles

Signatura

ResultGetDocumentXml getDocumentXml(ParamGetDocumentXml paramGetDocumentXml).

Parámetros de invocación

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

Ver detalles

Signatura

ResultInitializeAdministrativeFileMetadata initializeAdministrativeFileMetadata(ParamInitializeAdministrativeFileMetadata paramInitializeAdministrativeFileMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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 vicercersa.(1)

Parámetros de respuesta

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

Ver detalles

Signatura

ResultOpenAdministrativeFile openAdministrativeFile(ParamOpenAdministrativeFile paramOpenAdministrativeFile)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamOpenAdministrativeFile(hereda de ParamBase)
adminFile	AdministrativeFile	Si	Documento con el índice y metadatos del expediente
folderId	String	No	Identificador de la carpeta de Documentum
aclName	String	No	Nombre de la lista de control de accesos al fichero
signedDocument	SignedDocument	(1)	Documento contenido en el expediente
adminFileContentCsv	String	(2)	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 sera 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
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
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 parametro 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.

Ver detalles

Signatura

ResultCloseAdministrativeFile closeAdministrativeFile(ParamCloseAdministrativeFile paramCloseAdministrativeFile)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCloseAdministrativeFile (hereda de ParamBase)
csv	String	Si(1)	CSV del expediente del expediente a cerrar.
id	String	Si(1)	Identificador del expediente a cerrar.
date	Date	No	Fecha de cierre 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
ResultCloseAdministrativeFile(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultCloseAdministrativeFile

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

ParamCloseAdministrativeFile paramCloseAdministrativeFile = new ParamCloseAdministrativeFile();
paramCloseAdministrativeFile.setCsv("CSV6587268741454CCSV");
ResultCloseAdministrativeFile result = ccsvClient.closeAdministrativeFile(paramCloseAdministrativeFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'reopenAdministrativeFile'

Cambia el estado de un expediente a estado abierto (si esta cerrado). En caso de contener subexpedientes, tambien los vuelve a abrir.

Ver detalles

Signatura

ResultReopenAdministrativeFile reopenAdministrativeFile(ParamReopenAdministrativeFile paramReopenAdministrativeFile);

Parámetros de invocación

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

Códigos de error

Los errores de la invocación se encapsulan en ResultReopenAdministrativeFile

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.

Ver detalles

Signatura

ResultChangeAdministrativeFileState changeAdministrativeFileState(ParamChangeAdministrativeFileState paramChangeAdministrativeFileState);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamChangeAdministrativeFileState(hereda de ParamBase)
csv	String	Si(1)	CSV del expediente a cambiar de estado.
id	String	Si(1)	Identificador del expediente a cambiar de estado.
state	String	Si	Nuevo estado 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
ResultChangeAdministrativeFileState(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultChangeAdministrativeFileState

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente
1013	ERROR_ADMINFILE_STATENULO	Debe especificar el estado del expediente
1024	ERROR_ADMINFILE_CHANGESTATE	El expediente sólo se puede cambiar a estado Cerrado o a Índice para Remisión Cerrado
1023	ERROR_ADMINFILE_CHANGESTATE_NOTOPEN	No se puede cambiar el estado si el expediente no está abierto
1002	ERROR_DOCUMENTMETADATA	Error del DocumentMetadataManager
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

ParamChangeAdministrativeFileState paramChangeAdministrativeFileState = new ParamChangeAdministrativeFileState();
paramChangeAdministrativeFileState.setCsv("CSV854546458461CCSV");
paramChangeAdministrativeFileState.setState(DocumentumConstants.EstadoExpediente.INDICE_REMISION_CERRADO);
ResultChangeAdministrativeFileState result = ccsvClient.changeAdministrativeFileState(paramChangeAdministrativeFileState);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'annulateAdminFile'

Permite anular un expediente.

Ver detalles

Signatura

ResultAnnulateAdminFile annulateAdminFile(ParamAnnulateAdminFile param);

Parámetros de invocación

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

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

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

Método 'getAdministrativeFileIndex'

Recupera el índice del expediente

Ver detalles

Signatura

ResultGetAdministrativeFileIndex getAdministrativeFileIndex(ParamGetAdministrativeFileIndex paramGetAdministrativeFileIndex);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetAdministrativeFileIndex (hereda de ParamBase)
csv	String	Si(1)	CSV del indice del expediente a consultar.
id	String	Si(1)	Identificador del indice 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
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

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.

Ver detalles

Signatura

ResultRegenerateAdministrativeFileIndex regenerateAdministrativeFileIndex(ParamRegenerateAdministrativeFileIndex paramRegenerateAdministrativeFileIndex);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamRegenerateAdministrativeFileIndex (hereda de ParamBase)
csv	String	Si(1)	CSV del expediente del expediente del que se va a regenerar el indice.
id	String	Si(1)	Identificador del expediente del que se va a regenerar el indice.
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
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

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

Añade un documento existente en el gestor documental a un expediente en estado "Abierto". Para ello se deberá crear una relación entre el expediente y el documento 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, siempre y cuando el estado del documento sea original o copia.

Ver detalles

Signatura

ResultAddDocumentToAdminFile addDocumentToAdminFile(ParamAddDocumentToAdminFile paramAddDocumentToAdminFile);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddDocumentToAdminFile(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 documento a añadir
contentId	String	Si(2)	Identificador del documento 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 contentId y viceversa.(2)

NOTA 3: Si se rellena el adminFileFolderCodeno se rellena el adminFileFolderId y viceversa.(3)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultAddDocumentToAdminFile(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultAddDocumentToAdminFile

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente
1007	ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_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 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

ParamAddDocumentToAdminFile paramAddDocumentToAdminFile = new ParamAddDocumentToAdminFile();
paramAddDocumentToAdminFile.setId("0906fca3801922bb");
paramAddDocumentToAdminFile.setContentId("0907lca3801958jk");
ResultAddDocumentToAdminFile result = ccsvClient.addDocumentToAdminFile(paramAddDocumentToAdminFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'addNewDocumentToAdminFile'

Archiva el documento proporcionado en Documentum y lo incorpora a un expediente en estado "Abierto". Para ello se deberá crear una relación entre el expediente y el documento con rol "CONTIENE". Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encarge de regenerarlo, siempre y cuando el documento que se pasa al método venga junto con su firma.

Ver detalles

Signatura

ResultAddNewDocumentToAdminFile addNewDocumentToAdminFile(ParamAddNewDocumentToAdminFile paramAddNewDocumentToAdminFile);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddNewDocumentToAdminFile (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.
signedDocument	SignedDocument	Si(3)	Documento que se desea incorporar al expediente junto con su firma.
folderId	String	No	Identificador de la carpeta de Documentum
aclName	String	No	Nombre de la lista de control de accesos al fichero
adminFileFolderCode	String	No(2)	Código de la carpeta donde incluir el documento.
adminFileFolderId	String	No(2)	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 adminFileFolderCodeno se rellena el adminFileFolderId y viceversa.(2)

NOTA 3: Es obligatorio en el signedDocument el documento contenido, puede estar sin firmar ( no se añadirá al
índice hasta que no se firme).(3)

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultAddNewDocumentToAdminFile(hereda de ResultError)
id	String	Identificador del documento creado

Códigos de error

Los errores de la invocación se encapsulan en ResultAddNewDocumentToAdminFile

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente
1008	ERROR_ADMINFILE_DOC_CONTENIDO_NULO	Debe especificar un documento contenido y su firma
1028	ERROR_NOTEXIST_FOLDERINADMINFILE	No existe esa carpeta en el expediente especificado
1001	ERROR_OPEN_STATE	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

ParamAddNewDocumentToAdminFile paramAddNewDocumentToAdminFile = new ParamAddNewDocumentToAdminFile();
//signedDocument es un objeto SignedDocument que contiene todos los datos del documento
contenido que queremos crear y su firma
paramAddNewDocumentToAdminFile.setSignedDocument(signedDocument);
paramAddNewDocumentToAdminFile.setCsv("CSV545646546841456CCSV");
ResultAddNewDocumentToAdminFile result = ccsvClient.addNewDocumentToAdminFile(paramAddNewDocumentToAdminFile);
if(result.getReturnCode().equals(ReturnCode.OK){
	String id = result.getId();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'addDocumentsToAdminFile'

Añade una relación de documentos existentes en el gestor documental a un expediente en estado "Abierto". Para ello se deberá crear una relación entre el expediente y los documentos 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.

Ver detalles

Signatura

ResultAddDocumentsToAdminFile addDocumentsToAdminFile(ParamAddDocumentsToAdminFile paramAddDocumentsToAdminFile);

Parámetros de invocación

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

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

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

Archiva los documentos proporcionados en Documentum y los incorpora a un expediente en estado "Abierto". Para ello se deberá crear una relación entre el expediente y los documentos 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. Si ninguno de los documentos proporcionados va firmado no se regenerará el índice.

Ver detalles

Signatura

ResultAddNewDocumentsToAdminFile addNewDocumentsToAdminFile (ParamAddNewDocumentsToAdminFile paramAddNewDocumentsToAdminFile );

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddNewDocumentsToAdminFile (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.
documents	SignedDocument[]	Si(2)	Array de documentos que se desean incorporar al expediente y sus firmas.
folderId	String	No	Identificador de la carpeta de Documentum.
aclName	String	No	Nombre de la lista de control de accesos al fichero.
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: Es obligatorio en el signedDocument[] un mínimo de un documento contenido, los documentos pueden
estar sin firmar (no se añadirá al índice hasta que no se firme.)(2)

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

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultAddNewDocumentsToAdminFile(hereda de ResultError)
id	String[]	Identificadores de los documentos creados

Códigos de error

Los errores de la invocación se encapsulan en ResultAddNewDocumentsToAdminFile

Código	Nombre	Descripción
1017	ERROR_ADMINFILE_CSV_E_ID_NULOS	Debe especificar el id o el CSV del expediente.
1016	ERROR_ADMINFILE_DOC_CONTENIDOS_NULO	Debe especificar el array 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

ParamAddNewDocumentsToAdminFile paramAddNewDocumentsToAdminFile = new ParamAddNewDocumentsToAdminFile();
//signedDocuments es un objeto SignedDocument[] que contiene todos los datos de los documentos contenido que queremos crear y sus firmas
paramAddNewDocumentToAdminFile.setSignedDocument(signedDocuments);
paramAddNewDocumentToAdminFile.setCsv("CSV545646546841456CCSV");
ResultAddNewDocumentToAdminFile result = ccsvClient.addNewDocumentToAdminFile(paramAddNewDocumentToAdminFile);
if(result.getReturnCode().equals(ReturnCode.OK){
	String[] id = result.getId();
}else{
	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.

Ver detalles

Signatura

ResultAddAdministrativeFileToAdminFile addAdministrativeFileToAdminFile(ParamAddAdministrativeFileToAdminFile paramAddAdministrativeFileToAdminFile);

Parámetros de invocación

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

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.

Ver detalles

Signatura

ResultDeleteDocumentFromAdminFile deleteDocumentFromAdminFile(ParamDeleteDocumentFromAdminFile paramDeleteDocumentFromAdminFile );

Parámetros de invocación

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

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

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.

Ver detalles

Signatura

ResultMoveDocumentToRecycleFolder moveDocumentToRecycleFolder(ParamMoveDocumentToRecycleFolder paramMoveDocumentToRecycleFolder);

Parámetros de invocación

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

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.

Ver detalles

Signatura

ResultCreateAdministrativeFileFolder createAdministrativeFileFolder(ParamCreateAdministrativeFileFolder paramCreateAdministrativeFileFolder);

Parámetros de invocación

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

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.

Ver detalles

Signatura

ResultDeleteAdministrativeFileFolder deleteAdministrativeFileFolder(ParamDeleteAdministrativeFileFolder paramDeleteAdministrativeFileFolder);

Parámetros de invocación

Nombre	Tipo	Descriprició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
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

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

Método 'getAdministrativeFileFolder'

Obtiene una carpeta del expediente y los documentos contenidos en ella.

Ver detalles

Signatura

ResultGetAdministrativeFileFolder getAdministrativeFileFolder(ParamGetAdministrativeFileFolder paramGetAdministrativeFileFolder);

Parámetros de invocación

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

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

Método 'moveDocumentToFolder'

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.

Ver detalles

Signatura

ResultMoveDocumentToFolder moveDocumentToFolder(ParamMoveDocumentToFolder paramMoveDocumentToFolder);

Parámetros de invocación

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

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.

Ver detalles

Signatura

ResultMoveDocumentsToFolder moveDocumentsToFolder(ParamMoveDocumentsToFolder paramMoveDocumentsToFolder);

Parámetros de invocación

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

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.

Ver detalles

Signatura

ResultRemoveDocumentFromFolder removeDocumentFromFolder(ParamRemoveDocumentFromFolder paramRemoveDocumentFromFolder);

Parámetros de invocación

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

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

Método 'lastAddedContents'

Recupera los últimos documentos, expedientes, carpetas, añadidos desde la fecha indicada.

Ver detalles

Signatura

ResultLastAddedContents lastAddedContents(ParamLastAddedContents paramLastAddedContents);

Parámetros de invocación

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

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

Servicio IMetadataModelServicePortType

A continuación se muestran todos los métodos referentes a la administración del modelo de metadatos existente o anteriores, la gestión de tipos de documentos y documentales y la administración de los metadatos existentes.

Métodos para la gestión de modelos de metadatos.

Método 'getMetadataModelList'

Permite obtener un listado de los modelos de metadatos existentes en el sistema.

Ver detalles

Signatura

ResultGetMetadataModelList getMetadataModelList(ParamGetMetadataModelList paramGetMetadataModelList).

Parámetros de invocación

Nombre	Tipo	Descriprición
ParamGetMetadataModelList(hereda de ParamBase)

NOTA: Los parámetros de invocación se encapsulan en el objeto ParamGetMetadataModelList y no tiene atributos adicionales a los de la clase padre.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetMetadataModelList (hereda de ResultError)
metadataModelList	List<MetadataModel>	Lista con todos los modelos de metadatos

Códigos de error

Los errores de la invocación se encapsulan en ResultGetMetadataModelList

Código	Nombre	Descripción
800	ERROR_BASEDATOS_CSV	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

ParamGetMetadataModelList param = new ParamGetMetadataModelList();
ResultGetMetadataModelList result = cssvClient.getMetadataModelWs().getMetadataModelList(param);
if (result.getReturnCode().equals(ReturnCode.ERROR){
	log.error( result.getErrorCode()+":"+ result.getErrorMessage());
}

Método 'getCurrentMetadataModel'

Permite obtener el modelo de metadatos actual.

Ver detalles

Signatura

ResultGetCurrentMetadataModel getCurrentMetadataModel(ParamGetCurrentMetadataModel paramGetCurrentMetadataModel).

Parámetros de invocación

Nombre	Tipo	Descriprición
ParamGetCurrentMetadataModel(hereda de ParamBase)

NOTA: Los parámetros de invocación se encapsulan en el objeto ParamGetCurrentMetadataModel y no tiene atributos adicionales a los de la clase padre.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetCurrentMetadataModel(hereda de ResultError)
metadataModel	MetadataModel	Modelo de metadatos actual.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetCurrentMetadataModel

Código	Nombre	Descripción
718	ERROR_GET_CURRENT	No existe ningún modelo de datos actual.
800	ERROR_BASEDATOS_CSV	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

ParamGetCurrentMetadataModel paramGetCurrentMetadataModel = new ParamGetCurrentMetadataModel();
ResultGetCurrentMetadataModel result = cssvClient.getMetadataModelWs().getCurrentMetadataModel(paramGetCurrentMetadataModel);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result.getErrorCode()+":"+ result .getErrorMessage());
}

Método 'getMetadataModel'

Permite obtener un modelo de metadatos a partir de su identificador.

Ver detalles

Signatura

ResultGetMetadataModel getMetadataModel(ParamGetMetadataModel paramGetMetadataModel).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataModel(hereda de ParamBase)
metadataModelId	Long	Si	Identificador del modelo de metadatos a recuperar.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetMetadataModel(hereda de ResultError)
metadataModel	MetadataModel	Modelo de metadatos recuperado a partir del id.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetMetadataModel

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId
702	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado
800	ERROR_BASEDATOS_CSV	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

ParamGetMetadataModel paramGetMetadataModel = new ParamGetMetadataModel();
paramGetMetadataModel.setMetadataModelId(metadataModel.getMetadataModelId());
ResultGetMetadataModel result = cssvClient.getMetadataModelWs().getMetadataModel(paramGetMetadataModel);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'createMetadataModel'

Da de alta un nuevo modelo de metadatos.

Ver detalles

Signatura

ResultCreateMetadataModel createMetadataModel(ParamCreateMetadataModel paramCreateMetadataModel).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateMetadataModel(hereda de ParamBase)
metadataModel	MetadataModel	Si	Modelo de metados que se quiere crear nuevo.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultCreateMetadataModel(hereda de ResultError)
metadataModelId	Long	Identificador del modelo de metadatos creado.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetMetadataModel

Código	Nombre	Descripción
725	ERROR_CREATE_METADATAMODEL	EL nombre del modelo de metadatos ya existe
800	ERROR_BASEDATOS_CSV	Error al conectar con la Base de Datos CSV

Ejemplo de invocación

Invocación

ParamCreateMetadataModel paramCreateMetadataModel = new ParamCreateMetadataModel();
paramCreateMetadataModel.setMetadataModel(metadataModel);
ResultCreateMetadataModel result=cssvClient.getMetadataModelWs().createMetadataModel(paramCreateMetadataModel);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'cloneMetadataModel'

Permite clonar un modelo de metadatos ya existente.

Ver detalles

Signatura

ResultCloneMetadataModel cloneMetadataModel(ParamCloneMetadataModel paramCloneMetadataModel).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCloneMetadataModel(hereda de ParamBase)
metadataModelId	Long	Si	Identificador del modelo que se va a clonar.
newName	String	Si	Nombre del nuevo modelo de metadatos.
newDescription	String	SI	Descripción del nuevo modelo de metadatos.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultCloneMetadataModel(hereda de ResultError)
metadataModelId	Long	Identificador del modelo de metadatos creado.

Códigos de error

Los errores de la invocación se encapsulan en ResultCloneMetadataModel

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado.
725	ERROR_CREATE_METADATAMODEL	EL nombre del modelo de metadatos ya existe.
800	ERROR_BASEDATOS_CSV	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

ParamCloneMetadataModel paramCloneMetadataModel = new ParamCloneMetadataModel();
paramCloneMetadataModel.setMetadataModelId(metadataModel.getMetadataModelId());
ResultCloneMetadataModel result = cssvClient.getMetadataModelWs().cloneMetadataModel(paramCloneMetadataModel);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'updateMetadataModel'

Actualiza las propiedades de un modelo de metadatos ya existente.

Ver detalles

Signatura

ResultUpdateMetadataModel updateMetadataModel(ParamUpdateMetadataModel paramUpdateMetadataModel).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateMetadataModel(hereda de ParamBase)
metadataModel	MetadataModel	Si	Modelo de metadatos que se quiere actualizar.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultUpdateMetadataModel(hereda de ResultError)
list	List<String>	Listado con errores de validación del modelo de metadatos.

Códigos de error

Los errores de la invocación se encapsulan en ResultUpdateMetadataModel

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado.
717	ERROR_UPDATE_METADATAMODEL_HISTORICAL	No se puede modificar un modelo de metadatos actual o que ya ha utilizado Papiro.
800	ERROR_BASEDATOS_CSV	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

ParamUpdateMetadataModel paramUpdateMetadataModel = new ParamUpdateMetadataModel();
paramUpdateMetadataModel.setMetadataModel(metadataModel);
ResultUpdateMetadataModel result = ccsvClient.getMetadataModelWs().updateMetadataModel(paramUpdateMetadataModel);
if (result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteMetadataModel'

Elimina un modelo de metadatos del sistema.

Ver detalles

Signatura

ResultUpdateMetadataModel updateMetadataModel(ParamUpdateMetadataModel paramUpdateMetadataModel).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteMetadataModel(hereda de ParamBase)
metadataModelId	Long	Si	Identidicador del modelo de metadatos a eliminar

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultDeleteMetadataModel(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultDeleteMetadataModel

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado.
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
716	ERROR_DELETE_METADATAMODEL_HISTORICAL	No se puede borrar un modelo de metadatos actual o que ya ha utilizado Papiro.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

ParamDeleteMetadataModel paramDeleteMetadataModel = new ParamDeleteMetadataModel();
paramDeleteMetadataModel.setMetadataModelId(metadataModel.getMetadataModelId());
ResultDeleteMetadataModel result = cssvClient.getMetadataModelWs().deleteMetadataModel(paramDeleteMetadataModel);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos de tipos de documentos.

Método 'getDocumentTypeList'

Permite obtener la lista de tipos de documentos de un modelo de metadatos indicándole un identificador del modelo de metadatos y si debemos devolver todos los tipos de documento o sólo los destacados.

Ver detalles

Signatura

ResultGetDocumentTypeList getDocumentTypeList(ParamGetDocumentTypeList paramGetDocumentTypeList)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentTypeList(hereda de ParamBase)
metadataModelId	Long	Si	Identidicador del modelo de metadatos
hightlight	boolean	Si	Indica si se devuelven todos los tipos de documento o sólo los destacados

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetDocumentTypeList (hereda de ResultError)
documentTypeList	List<DocumentType>	Lista de Tipos de documento recuperados para un modelo de metadatos indicado

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocumentTypeList

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
719	ERROR_GET_HIGHLIGHT	No existe ningún tipo de documento destacado para ese modelo de metadatos.
721	ERROR_GET_DOCUMENTTYPELIST	No existe ningún tipo de documento para ese modelo de metadatos.
800	ERROR_BASEDATOS_CSV	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

ParamGetDocumentTypeList paramGetDocumentTypeList = new ParamGetDocumentTypeList();
ResultGetDocumentTypeList result = cssvClient.getMetadataModelWs().getDocumentTypeList(paramGetDocumentTypeList);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getDocumentType'

Permite obtener las propiedades de un tipo de documento.

Ver detalles

Signatura

ResultGetDocumentType getDocumentType(ParamGetDocumentType paramGetDocumentType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentTypeList(hereda de ParamBase)
documentTypeId	Long	Si	Identidicador del tipo de documento a recuperar

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetDocumentType(hereda de ResultError)
documentType	DocumentType	Tipo de documento recuperado.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocumentType

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId
705	ERROR_DOCUMENTTYPEID_NOEXISTE	No existe un tipo de documento con el identificador especificado
800	ERROR_BASEDATOS_CSV	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

ParamGetDocumentType paramGetDocumentType = new ParamGetDocumentType();
ResultGetDocumentType result = cssvClient.getMetadataModelWs().getDocumentType(paramGetDocumentType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'addDocumentType'

Da de alta un nuevo tipo de documento dentro del modelo de metadatos.

Ver detalles

Signatura

ResultAddDocumentType addDocumentType(ParamAddDocumentType paramAddDocumentType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddDocumentType(hereda de ParamBase)
documentType	DocumentType	Si	Tipo de documento a añadir

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultAddDocumentType(hereda de ResultError)
documentTypeId	Long	Identificador del tipo de documento creado.

Códigos de error

Los errores de la invocación se encapsulan en ResultAddDocumentType

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado.
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
704	ERROR_DOCUMENTUMTYPEID_NULO	Debe especificar un documentumTypeId.
715	ERROR_METADATAMODELID_DISTINTOS	Todos los parámetros deben pertenecer al mismo modelo de metadatos, compruebe si coincide con el modelo del tipo documental.
800	ERROR_BASEDATOS_CSV	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

ParamAddDocumentType paramAddDocumentType = new ParamAddDocumentType();
paramAddDocumentType.setDocumentType(documenType);
ResultAddDocumentType result = cssvClient.getMetadataModelWs().addDocumentType(paramAddDocumentType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result .getErrorCode()+":"+ result.getErrorMessage());
}

Método 'updateDocumentType'

Actualiza las propiedades de un tipo de documento.

Ver detalles

Signatura

ResultUpdateDocumentType updateDocumentType(ParamUpdateDocumentType paramUpdateDocumentType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateDocumentType(hereda de ParamBase)
documentType	DocumentType	Si	Tipo de documento que queremos actualizar

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultUpdateDocumentType(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultUpdateDocumentType

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
704	ERROR_DOCUMENTUMTYPEID_NULO	Debe especificar un documentumTypeId.
705	ERROR_DOCUMENTTYPEID_NOEXISTE	No existe un tipo de documento con el identificador especificado.
715	ERROR_METADATAMODELID_DISTINTOS	Todos los parámetros deben pertenecer al mismo modelo de metadatos, compruebe si coincide con el modelo del tipo documental.
800	ERROR_BASEDATOS_CSV	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

ParamUpdateDocumentType paramUpdateDocumentType = new ParamUpdateDocumentType();
paramUpdateDocumentType.setDocumentType(documentType);
ResultUpdateDocumentType result = cssvClient.getMetadataModelWs().updateDocumentType(paramUpdateDocumentType);
if (result .getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result .getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteDocumentType'

Elimina un tipo de documento.

Ver detalles

Signatura

ResultDeleteDocumentType deleteDocumentType(ParamDeleteDocumentType paramDeleteDocumentType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteDocumentType(hereda de ParamBase)
documentTypeId	Long	Si	Identidicador del tipo de documento a eleminar

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultDeleteDocumentType(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultDeleteDocumentType

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
705	ERROR_DOCUMENTTYPEID_NOEXISTE	No existe un tipo de documento con el identificador especificado.
800	ERROR_BASEDATOS_CSV	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

ParamDeleteDocumentType paramDeleteDocumentType = new ParamDeleteDocumentType();
ResultDeleteDocumentType result = cssvClient.getMetadataModelWs().deleteDocumentType(paramDeleteDocumentType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos de tipos documentales.

Método 'getDocumentumTypeList'

Permite obtener la lista de tipos documentales del modelo de metadatos seleccionado.

Ver detalles

Signatura

ResultGetDocumentumTypeList getDocumentumTypeList(ParamGetDocumentumTypeList paramGetDocumentumTypeList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentTypeList(hereda de ParamBase)
metadataModelId	Long	Si	Identificador del modelo de metadatos de los tipos documentales a recuperar.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetDocumentTypeList (hereda de ResultError)
documentumTypeList	List<DocumentumType>	Lista de Tipos documentales para un modelo de metadatos indicado.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocumentTypeList

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
720	ERROR_GET_DOCUMENTUMTYPELIST	No existe ningún tipo documental para ese modelo de metadatos.
800	ERROR_BASEDATOS_CSV	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

ParamGetDocumentumTypeList paramGetDocumentumTypeList = new ParamGetDocumentumTypeList();
ResultGetDocumentumTypeList result = cssvList.getMetadataModelWs().getDocumentumTypeList(paramGetDocumentumTypeList);
if (result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getDocumentumType'

Permite obtener un tipo documental del modelo de metadatos.

Ver detalles

Signatura

ResultGetDocumentumType getDocumentumType(ParamGetDocumentumType paramGetDocumentumType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentumType(hereda de ParamBase)
documentumTypeId	Long	Si	Identificador del tipo documental a recuperar

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetDocumentumType(hereda de ResultError)
documentumType	DocumentumType	Tipo documental recuperado.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocumentumType

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
705	ERROR_DOCUMENTTYPEID_NOEXISTE	No existe un tipo de documento con el identificador especificado.
800	ERROR_BASEDATOS_CSV	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

ParamGetDocumentumType paramGetDocumentumType = new ParamGetDocumentumType();
ResultGetDocumentumType result = cssvClient.getMetadataModelWs().getDocumentumType(paramGetDocumentumType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'addDocumentumType'

Da de alta un nuevo tipo documental.

Ver detalles

Signatura

ResultAddDocumentumType addDocumentumType(ParamAddDocumentumType paramAddDocumentumType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddDocumentumType(hereda de ParamBase)
documentumType	DocumentumType	Si	Tipo documental que se quiere añadir.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultAddDocumentumType(hereda de ResultError)
documentumTypeId	Long	Identificador del tipo documental creado.

Códigos de error

Los errores de la invocación se encapsulan en ResultAddDocumentumType

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
715	ERROR_METADATAMODELID_DISTINTOS	Todos los parámetros deben pertenecer al mismo modelo de metadatos, compruebe si coincide con el modelo del tipo documental indicado.
800	ERROR_BASEDATOS_CSV	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

ParamAddDocumentumType paramAddDocumentumType = new ParamAddDocumentumType();
paramAddDocumentumType.setDocumentumType(documentumType);
ResultAddDocumentumType result = cssvClient.getMetadataModelWs().addDocumentumType(paramAddDocumentumType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'cloneDocumentumType'

Permite clonar un tipo documental ya existente, copiando así los metadatos y los valores

Ver detalles

Signatura

ResultCloneDocumentumType cloneDocumentumType(ParamCloneDocumentumType paramCloneDocumentumType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCloneDocumentumType(hereda de ParamBase)
documentumTypeId	Long	Si	Identificador del tipo documental que se va a clonar
newName	String	Si	Nombre del nuevo tipo documental
newNameNTI	String	Si	Nombre NTI del nuevo tipo documental
newDescription	String	Si	Descripción del nuevo tipo documental

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultCloneDocumentumType(hereda de ResultError)
documentumTypeId	Long	Identificador del tipo documental clonado.

Códigos de error

Los errores de la invocación se encapsulan en ResultCloneDocumentumType

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
703	ERROR_DOCUMENTUMTYPEID_NOEXISTE	No existe un tipo documental con el identificador especificado.
800	ERROR_BASEDATOS_CSV	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

ParamCloneDocumentumType paramCloneDocumentumType = new ParamCloneDocumentumType();
ResultCloneDocumentumType result = metadataModel.cloneDocumentumType(paramCloneDocumentumType);
cssvClient.setClonedDocumentumType(true);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+”:”+result.getErrorMessage());
}

Método 'updateDocumentumType'

Actualiza las propiedades de un tipo documental del modelo de metadatos

Ver detalles

Signatura

ResultUpdateDocumentumType updateDocumentumType(ParamUpdateDocumentumType paramUpdateDocumentumType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateDocumentumType(hereda de ParamBase)
documentumType	DocumentumType	Si	Tipo de documental que queremos actualizar

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultUpdateDocumentumType(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultUpdateDocumentumType

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
703	ERROR_DOCUMENTUMTYPEID_NOEXISTE	No existe un tipo documental con el identificador especificado.
715	ERROR_METADATAMODELID_DISTINTOS	Todos los parámetros deben pertenecer al mismo modelo de metadatos, compruebe si coincide con el modelo del tipo documental indicado.
800	ERROR_BASEDATOS_CSV	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

ParamUpdateDocumentumType paramUpdateDocumentumType = new ParamUpdateDocumentumType();
paramUpdateDocumentumType.setDocumentumType(documentumType);
ResultUpdateDocumentumType result = cssvClient.getMetadataModelWs().updateDocumentumType(paramUpdateDocumentumType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+ result.getErrorMessage());
}

Método 'deleteDocumentumType'

Elimina un tipo documental del modelo de metadato.

Ver detalles

Signatura

ResultDeleteDocumentumType deleteDocumentumType(ParamDeleteDocumentumType paramDeleteDocumentumType).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteDocumentumType(hereda de ParamBase)
documentumTypeId	Long	Si	Identificador del tipo de documental a eliminar.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultDeleteDocumentumType(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultDeleteDocumentumType

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
711	ERROR_DELETE_DOCUMENTUMTYPE_DOCUMENTUMTYPE	Existe algún tipo documental hijo, asociado al tipo documental que ha intentado borrar.
712	ERROR_DELETE_DOCUMENTUMTYPE_DOCUMENTTYPE	Existe algún tipo de documento asociado al tipo documental que ha intentado borrar.
713	ERROR_DELETE_DOCUMENTUMTYPE_METADATATYPE	Existe algún metadato asociado al tipo documental que ha intentado borrar.
714	ERROR_DELETE_CLONED	No se puede borrar porque afecta una versión anterior.
800	ERROR_BASEDATOS_CSV	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

ParamDeleteDocumentumType paramDeleteDocumentumType = new ParamDeleteDocumentumType();
paramDeleteDocumentumType.setDocumentumTypeId(documentumType.getDocumentumTypeId());
ResultDeleteDocumentumType result = cssvClient.getMetadataModelWs().deleteDocumentumType(paramDeleteDocumentumType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+ result.getErrorMessage());
}

Métodos de metadatos.

Método 'getMetadataList'

Permite obtener la lista de metadatos de un tipo documental.

Ver detalles

Signatura

ResultGetMetadataList getMetadataList(ParamGetMetadataList paramGetMetadataList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataList(hereda de ParamBase)
documentumTypeId	Long	Si	Identificador del tipo documental de los metadatos a recuperar.
addMetadataParent	Boolean	Si	Indica si devuelve también los metadatos de los tipos documentales padre

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetMetadataList(hereda de ResultError)
metadataList	List<Metadata>	Lista de metadatos para un determinado tipo documental.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetMetadataList

Código	Nombre	Descripción
722	ERROR_GET_METADATALIST	No existe ningún metadato para ese tipo documental.
800	ERROR_BASEDATOS_CSV	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

ParamGetMetadataList paramGetMetadataList = new ParamGetMetadataList();
paramGetMetadataList.setDocumentumTypeId(metadata.getDocumentumTypeId());
paramGetMetadataList.setAddMetadataParent(Boolean.FALSE);
ResultGetMetadataList result = cssvClient.getMetadataModelWs().getMetadataList(paramGetMetadataList);
if (result.getReturnCode().equals(ReturnCode.ERROR){
	log.error( result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getMetadata'

Permite obtener las propiedades de un metadato de un tipo documental

Ver detalles

Signatura

ResultGetMetadata getMetadata(ParamGetMetadata paramGetMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadata(hereda de ParamBase)
metadataId	Long	Si	Identificador del metadato a recuperar.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetMetadata(hereda de ResultError)
metadata	Metadata	Datos del metadato recuperado.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetMetadata

Código	Nombre	Descripción
707	ERROR_METADATAID_NOEXISTE	No existe un metadato con el identificador especificado
708	ERROR_METADATAID_NULO	Debe especificar un metadataId.
800	ERROR_BASEDATOS_CSV	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

ParamGetMetadata paramGetMetadata = new ParamGetMetadata();
paramGetMetadata.setMetadataId(metadata);
ResultGetMetadata result = cssvClient.getMetadataModelWs().getMetadata(paramGetMetadata);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'addMetadata'

Da de alta un nuevo metadato dentro de un tipo documental

Ver detalles

Signatura

ResultAddMetadata addMetadata(ParamAddMetadata paramAddMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddMetadata (hereda de ParamBase)
metadata	Metadata	Si	Datos del metadato que se quiere añadir.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultAddMetadata(hereda de ResultError)
metadataId	Long	Identificador del metadato que se ha creado.

Códigos de error

Los errores de la invocación se encapsulan en ResultAddMetadata

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado.
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
715	ERROR_METADATAMODELID_DISTINTOS	Todos los parámetros deben pertenecer al mismo modelo de metadatos, compruebe si coincide con el modelo del tipo documental indicado.
800	ERROR_BASEDATOS_CSV	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

ParamAddMetadata paramAddMetadata = new ParamAddMetadata();
paramAddMetadata.setMetadata(metadata);
ResultAddMetadata result = metadataModelBL.getMetadataModelWs().addMetadata(paramAddMetadata);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'updateMetadata'

Actualiza las propiedades de un metadato.

Ver detalles

Signatura

ResultUpdateMetadata updateMetadata(ParamUpdateMetadata paramUpdateMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateMetadata(hereda de ParamBase)
metadata	Metadata	Si	Datos del metadato que se quiere actualizar.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultUpdateMetadata(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultUpdateMetadata

Código	Nombre	Descripción
701	ERROR_METADATAMODELID_NOEXISTE	No existe un modelo de metadatos con el identificador especificado.
703	ERROR_DOCUMENTUMTYPEID_NOEXISTE	No existe un tipo documental con el identificador especificado
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
715	ERROR_METADATAMODELID_DISTINTOS	Todos los parámetros deben pertenecer al mismo modelo de metadatos, compruebe si coincide con el modelo del tipo documental indicado.
800	ERROR_BASEDATOS_CSV	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

ParamUpdateMetadata paramUpdateMetadata = new ParamUpdateMetadata();
paramUpdateMetadata.setMetadata(metadata);
ResultUpdateMetadata result = cssvClient.getMetadataModelWs().updateMetadata(paramUpdateMetadata);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteMetadata'

Elimina un metadato dentro de un tipo documental.

Ver detalles

Signatura

ResultDeleteMetadata deleteMetadata(ParamDeleteMetadata paramDeleteMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteMetadata(hereda de ParamBase)
metadataId	Long	Si	Identidicador del metadato a eleminar.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultDeleteMetadata(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultDeleteMetadata

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
714	ERROR_DELETE_CLONED	No se puede borrar porque afecta una versión anterior
800	ERROR_BASEDATOS_CSV	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

ParamDeleteMetadata paramDeleteMetadata = new ParamDeleteMetadata();
paramDeleteMetadata.setMetadataId(metadata.getMetadataId());
ResultDeleteMetadata result = cssvClient.getMetadataModelWs().deleteMetadata(paramDeleteMetadata);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Métodos de valores de metadatos.

Método 'getMetadataValueList'

Permite obtener la lista de posibles valores para un metadato.

Ver detalles

Signatura

ResultGetMetadataValueList getMetadataValueList(ParamGetMetadataValueList paramGetMetadataValueList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataValueList(hereda de ParamBase)
metadataId	Long	Si	Identificador del metadato del que queremos recuperar sus posibles valores.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetMetadataValueList (hereda de ResultError)
metadataValueList	List<MetadataValue>	Lista de posibles valores para un metadato específico.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetMetadataValueList

Código	Nombre	Descripción
723	ERROR_GET_METADATAVALUELIST	Debe especificar un metadataId.
800	ERROR_BASEDATOS_CSV	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

ParamGetMetadataValueList paramGetMetadataValueList = new ParamGetMetadataValueList();
paramGetMetadataValueList.setMetadataId(metadata.getMetadataId());
ResultGetMetadataValueList result = cssvClient.getMetadataModelWs().getMetadataValueList(paramGetMetadataValueList);
if (result.getReturnCode().equals(ReturnCode.ERROR){
	log.error( result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getMetadataDefaultValue'

Permite obtener las propiedades del valor por defecto de un determinado metadato.

Ver detalles

Signatura

ResultGetMetadataDefaultValue getMetadataDefaultValue(ParamGetMetadataDefaultValue paramGetDefaultValue).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataDefaultValue(hereda de ParamBase)
metadataId	Long	Si	Identificador del metadato del que se quiere recuperar su valor por defecto.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetMetadataDefaultValue (hereda de ResultError)
metadataValue	MetadataValue	MetadataValue por defecto para un determinado metadato.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetMetadataDefaultValue

Código	Nombre	Descripción
708	ERROR_METADATAID_NULO	Debe especificar un metadataId.
724	ERROR_GET_METADATADEFAULTVALUE	No existe ningún valor por defecto para ese metadato.
800	ERROR_BASEDATOS_CSV	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

ParamGetMetadataDefaultValue paramGetDefaultValue= new ParamGetMetadataDefaultValue();
paramGetDefaultValue.setMetadataId(metadata.getMetadataId());
ResultGetMetadataDefaultValue result = cssvClient.getMetadataModelWs().getMetadataValueList(paramGetMetadataValueList);
if (result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'getMetadataValue'

Permite obtener las propiedades de uno de los valores posibles de un metadato.

Ver detalles

Signatura

ResultGetMetadataValue getMetadataValue(ParamGetMetadataValue paramGetMetadataValue).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataValue(hereda de ParamBase)
metadataValueId	Long	Si	Identificador del metadataValue a recuperar.

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultGetMetadataValue(hereda de ResultError)
metadataValue	MetadataValue	Metadatavalue recuperado.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetMetadataValue

Código	Nombre	Descripción
709	ERROR_METADATAVALUEID_NOEXISTE	No existe un valor de metadato con el identificador especificado.
710	ERROR_METADATAVALUEID_NULO	Debe especificar un metadataValueId.
800	ERROR_BASEDATOS_CSV	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

ParamGetMetadataValue paramGetMetadataValue = new ParamGetMetadataValue();
paramGetMetadataValue.setMetadataValueId(metadataValue.getMetadataValueId());
ResultGetMetadataValue result = cssvClient.getMetadataModelWs().getMetadataValue(paramGetMetadataValue);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+ result.getErrorMessage());
}

Método 'addMetadataValue'

Da de alta un nuevo valor para un determinado metadato.

Ver detalles

Signatura

ResultAddMetadataValue addMetadataValue(ParamAddMetadataValue paramAddMetadataValue).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamAddMetadataValue(hereda de ParamBase)
metadataValue	MetadataValue	Si	MetadataValue que se quiere añadir

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultAddMetadataValue(hereda de ResultError)
metadataValueId	Long	Identificador del MetadataValue creado.

Códigos de error

Los errores de la invocación se encapsulan en ResultAddMetadataValue

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
707	ERROR_METADATAID_NOEXISTE	No existe un metadato con el identificador especificado.
800	ERROR_BASEDATOS_CSV	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

ParamAddMetadataValue paramAddMetadataValue = new ParamAddMetadataValue();
paramAddMetadataValue.setMetadataValue(metadataValue);
ResultAddMetadataValue result = cssvClient.getMetadataModelWs().addMetadataValue(paramAddMetadataValue);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'updateMetadataValue'

Actualiza las propiedades del valor de un metadato.

Ver detalles

Signatura

ResultUpdateMetadataValue updateMetadataValue(ParamUpdateMetadataValue paramUpdateMetadataValue).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateMetadataValue(hereda de ParamBase)
metadataValue	MetadataValue	Si	MetadataValue que queremos actualizar

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultUpdateMetadataValue(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultUpdateMetadataValue

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe especificar un metadataModelId.
707	ERROR_METADATAID_NOEXISTE	No existe un metadato con el identificador especificado.
709	ERROR_METADATAVALUEID_NOEXISTE	No existe un valor de metadato con el identificador especificado.
800	ERROR_BASEDATOS_CSV	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

ParamUpdateMetadataValue paramUpdateMetadataValue = new ParamUpdateMetadataValue();
paramUpdateMetadataValue.setMetadataValue(metadataValue);
ResultUpdateMetadataValue result = cssvClient.getMetadataModelWs().updateMetadataValue(paramUpdateMetadataValue);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error( result.getErrorCode()+":"+result.getErrorMessage());
}

Método 'deleteMetadataValue'

Elimina uno de los posibles valores de un metadato.

Ver detalles

Signatura

ResultDeleteMetadataValue deleteMetadataValue(ParamDeleteMetadataValue paramDeleteMetadataValue).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteMetadataValue(hereda de ParamBase)
metadataValueId	Long	Si	Identidicador del valor del metadato que se va a eleminar

Parámetros de respuesta

Nombre	Tipo	Descripción
ResultDeleteMetadataValue(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultDeleteMetadataValue

Código	Nombre	Descripción
702	ERROR_METADATAMODELID_NULO	Debe eMspecificar un metadataModelId.
709	ERROR_METADATAVALUEID_NOEXISTE	No existe un valor de metadato con el identificador especificado.
800	ERROR_BASEDATOS_CSV	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

ParamDeleteMetadataValue paramDeleteMetadataValue = new ParamDeleteMetadataValue();
paramDeleteMetadataValue.setMetadataValueId(metadataId);
ResultDeleteMetadataValue result =
cssvClient.getMetadataModelWs().deleteMetadataValue(paramDeleteMetadataValue);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

Servicios para la gestión de expedientes

Servicio IAdministrativeFileServicePortType

Métodos para la gestión de expedientes

Método 'getAdministrativeFile'

Invocación

Método 'getAdminFileLite'

Invocación

Método 'getAdminFileLiteAdv'

Invocación

Método 'getDocumentXml'

Invocación

Método 'initializeAdministrativeFileMetadata'

Invocación

Método 'openAdministrativeFile'

Invocación

Método 'closeAdministrativeFile'

Invocación

Método 'reopenAdministrativeFile'

Invocación

Método 'changeAdministrativeFileState'

Invocación

Método 'annulateAdminFile'

Invocación

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

Método 'getAdministrativeFileIndex'

Invocación

Método 'regenerateAdministrativeFileIndex'

Invocación

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

Método 'addDocumentToAdminFile'

Invocación

Método 'addNewDocumentToAdminFile'

Invocación

Método 'addDocumentsToAdminFile'

Invocación

Método 'addNewDocumentsToAdminFile'

Invocación

Método 'addAdministrativeFileToAdminFile'

Invocación

Método 'deleteDocumentFromAdminFile'

Invocación

Método 'moveDocumentToRecycleFolder'

Invocación

Métodos para la gestión de carpetas.

Método 'createAdministrativeFileFolder'

Invocación

Método 'deleteAdministrativeFileFolder'

Invocación

Método 'getAdministrativeFileFolder'

Invocación

Método 'moveDocumentToFolder'

Invocación

Método 'moveDocumentsToFolder'

Invocación

Método 'removeDocumentFromFolder'

Invocación

Método 'lastAddedContents'

Invocación

Servicio IMetadataModelServicePortType

Métodos para la gestión de modelos de metadatos.

Método 'getMetadataModelList'

Invocación

Método 'getCurrentMetadataModel'

Invocación

Método 'getMetadataModel'

Invocación

Método 'createMetadataModel'

Invocación

Método 'cloneMetadataModel'

Invocación

Método 'updateMetadataModel'

Invocación

Método 'deleteMetadataModel'

Invocación

Métodos de tipos de documentos.

Método 'getDocumentTypeList'

Invocación

Método 'getDocumentType'

Invocación

Método 'addDocumentType'