Servicio IissueService

CreateIssue

El método createIssue tiene como finalidad permitir la creación de un envío dentro de bandeja de entrada, su invocación retornará un número que será el identificador del envío creado, que podrá ser utilizado posteriormente para realizar consultas sobre dicho envío. Para integrarse con este método será necesario ponerse en contacto con el equipo de desarrollo de BENT para tipificar el envío según la aplicación y dar de alta a la misma en la configuración desde el módulo administrativo (se detalla esto en el manual de administrador)

...

Image Removed

• Usuario: sería la persona que realiza la operación, la finalidad es preparar una serie de documentos que remitirá a bandeja de entrada para que sea enviado hasta el destinatario seleccionado.

• Aplicación externa: es la aplicación que se va integrar con Bandeja de Entrada, se encargará de realizar las operaciones previas necesarias de creación y firma de documentos.

• Crear documentos en CCSV: los documentos deben quedar almacenados en CCSV junto con sus firmas si estas están creadas.

• Registro en SRT: el documento de registro es necesario para que el proceso de envío pueda realizarse, la aplicación externa deberá crear y firmar el documento de registro.

• Bandeja de Entrada: la aplicación que se encarga de generar el envío y remitirlo hasta el destinatario.

El resultado del alta es el identificador único del envío creado.

Signatura

public Long createIssue(ParamCreateIssue paramCreateIssue) throws InternalCoreException

Parámetros de entrada:

ParamCreateIssue

...

Parámetro

...

Tipo

...

Obligatorio

...

Descripción

...

documentList

...

List<es.aragon.bent.core.ws.data.Document>

...

SI

...

Lista con los documentos del envío, La clase Document extiende BaseData, deben informarse los campos:

• csv: string

• applicationId: id de la aplicación integradora

(IMPORTANTE: los documentos que estén en estado borrador no serán añadidos al envío)

...

csvMaindoc

...

String

...

SI

...

CSV del documento principal, este csv debe estar incluido en el parametro de listado de documentos

...

description

...

String

...

SI

...

Descripción del envío

...

insertRegistry

...

String

...

NO

...

Insertar registro en organismos intermedios (valores aceptados: S/N, por defecto N o nulo)

...

viewDetail

...

String

...

NO

...

Ver detalle en organismo intermedios (valores aceptados: S/N, por defecto N o nulo)

...

viewTrace

...

String

...

NO

...

Ver traza en organismo intermedios (valores aceptados: S/N, por defecto N o nulo)

...

senderDni

...

String

...

NO

...

DNI del remitente

...

senderName

...

String

...

NO

...

Nombre del remitente

...

senderOrgCode

...

String

...

NO

...

Código del Organismo remitente

...

receiverDni

...

String

...

NO

...

DNI del receptor

...

receiverOrgCode

...

String

...

SI

...

Código del Organismo receptor

...

inmediateSend

...

Boolean

...

NO

...

Servicio IissueService

...

CreateIssue

El método createIssue tiene como finalidad permitir la creación de un envío dentro de bandeja de entrada, su invocación retornará un número que será el identificador del envío creado, que podrá ser utilizado posteriormente para realizar consultas sobre dicho envío. Para integrarse con este método será necesario ponerse en contacto con el equipo de desarrollo de BENT para tipificar el envío según la aplicación y dar de alta a la misma en la configuración desde el módulo administrativo (se detalla esto en el manual de administrador)

<arg0>
            <applicationId>APP_CODE</applicationId>
            <csvMaindoc>CSVJ529Y7L77G1W0BENT</csvMaindoc>
            <description>envío origen administración interna</description>
            <documentList>
               <applicationId>APP_CODE</applicationId>
               <csv>CSVJ529Y7L77G1W0BENT</csv>
            </documentList>
            <documentList>
               <applicationId>CPPC</applicationId>
               <csv>CSVGK37WVC2761V0BENT</csv>           
            </documentList>
            <insertRegistry>N</insertRegistry>
            <issuerDni>00000000T</issuerDni>
            <origen>0</origen>
            <receiverDni>00000000T</receiverDni>
            <receiverOrgCode>ORG07464</receiverOrgCode>
            <senderOrgCode>ORG07458</senderOrgCode>
</arg0>

<arg0>
            <applicationId>APP_CODE</applicationId>
            <csvMaindoc>CSVV21UZAF88L1M0BENT</csvMaindoc>
            <description>prueba </description>
            <documentList>
               <applicationId>APP_CODE</applicationId>
               <csv>CSVV21UZAF88L1M0BENT</csv>            
            </documentList>
            <documentList>
               <applicationId>APP_CODE</applicationId>
               <csv>CSV5U2UDSD48F1E0BENT</csv>             
            </documentList>
            <origen>1</origen>
            <receiverOrgCode>ORG06670</receiverOrgCode>
            <senderDni>73133419C</senderDni>
            <senderName>DIEGO PATRICIO GONZALEZ PARAMO</senderName>
</arg0>

<arg0>
            <applicationId>APP_CODE</applicationId>
            <csvMaindoc>CSVJ529Y7L77G1W0BENT</csvMaindoc>
            <description>prueba </description>
            <documentList>
               <applicationId>APP_CODE</applicationId>
               <csv>CSVJ529Y7L77G1W0BENT</csv>              
            </documentList>
            <!-- 2 Comunicacion - 3 Notificacion -->
            <origen>2</origen>
            <receiverOrgCode>ORG06670</receiverOrgCode>
            <senderDni>00000000T</senderDni>
            <senderName>Organismo Externo</senderName>		  
</arg0>

AcceptIssue

Este método permite aceptar un envío creando una traza con la fecha de aceptación. Los envios considerados como aceptables son los que tienen como ultimo evento uno de tipo 1 (envio) o 4 (reenvio), cuyo estado es finalizado OK (3) y no contienen documentos editables. Tampoco se permite realizar una aceptación sobre una importación de REGFIA directamente.

En caso de que el envío se encuentre en esta situación, se comprobará también que el receptor último del envío coincida con el indicado en los parametros userNif o userOrganismCode dependiendo de si el receptor es un funcionario o un organismo.

Signatura

...

arg0>

AcceptIssue

Este método permite aceptar un envío creando una traza con la fecha de aceptación. Los envios considerados como aceptables son los que tienen como ultimo evento uno de tipo 1 (envio) o 4 (reenvio), cuyo estado es finalizado OK (3) y no contienen documentos editables. Tampoco se permite realizar una aceptación sobre una importación de REGFIA directamente.

En caso de que el envío se encuentre en esta situación, se comprobará también que el receptor último del envío coincida con el indicado en los parametros userNif o userOrganismCode dependiendo de si el receptor es un funcionario o un organismo.

Signatura

public ResultAcceptIssue acceptIssue(ParamAcceptIssue paramAcceptIssue) throws InternalCoreException

Parámetros de entrada

Parámetros de salida

Ejemplo de invocación

ParamAcceptIssue paramAcceptIssue = new ParamAcceptIssue();
 
paramAcceptIssue.setIssueId(Long.parseLong(issueId));
// indicar unicamente este parametro si el receptor ultimo del envio es personal
paramAcceptIssue.setUserNif(userNif));
// indicar unicamente este parametro si el receptor ultimo del envio es un organismo
paramAcceptIssue.setUserOrganismCode(userOrganismCode);
paramAcceptIssue.setNotes(notes);
 
ResultAcceptIssue result = issueManager.getiIssueService().acceptIssue(paramAcceptIssue);
 
if (BENTCoreConstants.SendResult.ISSUE_ACCEPTED.equals(result.getResult()) {
	log.info("Envio aceptado");
} else if (BENTCoreConstants.SendResult.ISSUE_ESTATE_INVALID.equals(result.getResult()) {
	log.ingo("El envío no se encontraba en estado de poder ser aceptado");
} else if (BENTCoreConstants.SendResult.USER_WITHOUT_PERMISSION.equals(result.getResult()) {
	log.info("El usuario/organismo indicado no era el correspondiente para aceptar el envío");
}

ImportRegfiaEntry

Este método permite realizar la importación de un asiento de REGFIA en BENT

Signatura

public ResultImportRegfiaEntry importRegfiaEntry(ParamImportRegfiaEntry paramImportRegfiaEntry)

Parámetros de entrada

Parámetros de salida

Ejemplo de invocación

ParamImportRegfiaEntry arg6 = new ParamImportRegfiaEntry();

// parametros obtenidos del asiento de REGFIA
arg6.setApplicationId("BENT");
arg6.setAsunto("Programa emprendedores autónomos");
arg6.setCodOrganismoDestino("ORG06670");
arg6.setCodOrganismoOrigen(null);
arg6.setDsOrganismoOrigen(null);
arg6.setIdentificadorAgente("17756357N");
arg6.setNombreCompletoAgente("Mª Jose Montesa Letosa");
arg6.setNumeroRegistro("E20140015950");
arg6.setTipoAsiento("E");

// el asiento de REGFIA contiene un listado de objetos document de REGFIA, solo se pasa un listado de String con los csvs
List<String> csvList = new ArrayList<String>();
csvList.add("CSVO33FKMM3S6AE01PFI");
arg6.setCsvList(csvList);
 
ResultImportRegfiaEntry result = bentClient.importRegfiaEntry(arg6);
 
if (result.getError()) {
    log.error("Error: " + result.getErrorMsg());
} else {
    log.info("OK: " + result.getIssueId()");
}

ParamImportRegfiaEntry

La clase ParamImportRegfiaEntry encapsula los parametros del asiento de REGFIA que son necesario para realizar la importacion en BENT tal y como los devuelve esta aplicacion en el metodo getRegistry.

 Ver detalles

( * ) deben introducirse los datos del organismo origen, o del agente interesado obligatoriamente. En cualquier caso estos parametros se deben rellenar siempre con lo que venga informado en el asiento de REGFIA: organismoOrigen e interesados (el primero del listado).

ResultImportRegfiaEntry

La clase ResultImportRegfiaEntry contiene el resultado de la importación.

 Ver detalles

FindIssueTrayAdvanced

Método que devuelve una lista de envíos correspondientes de la bandeja de recibidos con filtros avanzados

Signatura

public ResultTrayListAdvanced findIssueTray(ParamFindTrayAdvanced paramTraySearch) throws InternalCoreException

Parámetros de entrada

Parámetros de salida

Excepciones

Ejemplo de invocación

ResultTrayListAdvanced resultTrayList = new ResultTrayListAdvanced();
ParamFindTrayAdvanced paramTraySearch = new ParamFindTrayAdvanced();
 
paramTraySearch.setIssueId(Long.parseLong(issueId));
paramTraySearch.setFromIndex(-1);
paramTraySearch.setReceiverDni(user.getNif());
paramTraySearch.setReceiverOrgCode(user.getOrganismCode());
 
resultTrayList = issueManager.getiIssueService().findIssueTrayAdvanced(paramTraySearch);

ParamFindTrayAdvanced

La clase ParamFindTrayAdvanced es la que contiene los parámetros para la obtención de los listados que se muestran en las bandejas que ve el usuario, se la bandeja de usuario o la de organismo, tanto para entrada como para salida, con filtros adicionales.

 Ver detalles

ResultTrayListAdvanced

La clase ResultTrayListAdvanced contiene el resultado de buscar la lista de trazas de un envío.

 Ver detalles

ParamReceivedTrayAdvanced

La clase ParamReceivedTrayAdvanced contiene los datos a mostrar en el listado de la bandeja de recibidos.

 Ver detalles

FindIssueTrayExternal

Método que devuelve una lista de envíos correspondientes de la bandeja de recibidos con filtros avanzados

Signatura

public ResultTrayListExternal findIssueTrayAppExternal(ParamFindTrayExternal paramTraySearch) throws InternalCoreException {

Parámetros de entrada

Parámetros de salida

Parámetros de salida

Excepciones

Ejemplo de invocación

ParamAcceptIssue paramAcceptIssue = new ParamAcceptIssue();
 
paramAcceptIssue.setIssueId(Long.parseLong(issueId));
// indicar unicamente este parametro si el receptor ultimo del envio es personal
paramAcceptIssue.setUserNif(userNif));
// indicar unicamente este parametro si el receptor ultimo del envio es un organismo
paramAcceptIssue.setUserOrganismCode(userOrganismCode);
paramAcceptIssue.setNotes(notes);
 
ResultAcceptIssue result = issueManager.getiIssueService().acceptIssue(paramAcceptIssue);
 
if (BENTCoreConstants.SendResult.ISSUE_ACCEPTED.equals(result.getResult()) {
	log.info("Envio aceptado");
} else if (BENTCoreConstants.SendResult.ISSUE_ESTATE_INVALID.equals(result.getResult()) {
	log.ingo("El envío no se encontraba en estado de poder ser aceptado");
} else if (BENTCoreConstants.SendResult.USER_WITHOUT_PERMISSION.equals(result.getResult()) {
	log.info("El usuario/organismo indicado no era el correspondiente para aceptar el envío");
}

ImportRegfiaEntry

Este método permite realizar la importación de un asiento de REGFIA en BENT

Signatura

public ResultImportRegfiaEntry importRegfiaEntry(ParamImportRegfiaEntry paramImportRegfiaEntry)

Parámetros de entrada

...

Parámetro

...

Tipo

...

Obligatorio

...

Descripción

...

paramImportRegfiaEntry

...

ParamImportRegfiaEntry

...

SI

...

Objeto donde están encapsulados los datos relativos al asiento a importar

Parámetros de salida

...

Parámetro

...

Tipo

...

Descripción

...

resultImportRegfiaEntry

...

ResultImportRegfiaEntry

...

Objeto que contiene el id de envio generado en BENT, o la informacion del error producido

Ejemplo de invocación

...

ParamImportRegfiaEntry arg6 = new ParamImportRegfiaEntry();

// parametros obtenidos del asiento de REGFIA
arg6.setApplicationId("BENT");
arg6.setAsunto("Programa emprendedores autónomos");
arg6.setCodOrganismoDestino("ORG06670");
arg6.setCodOrganismoOrigen(null);
arg6.setDsOrganismoOrigen(null);
arg6.setIdentificadorAgente("17756357N");
arg6.setNombreCompletoAgente("Mª Jose Montesa Letosa");
arg6.setNumeroRegistro("E20140015950");
arg6.setTipoAsiento("E");

// el asiento de REGFIA contiene un listado de objetos document de REGFIA, solo se pasa un listado de String con los csvs
List<String> csvList = new ArrayList<String>();
csvList.add("CSVO33FKMM3S6AE01PFI");
arg6.setCsvList(csvList);
 
ResultImportRegfiaEntry result = bentClient.importRegfiaEntry(arg6);
 
if (result.getError()) {
    log.error("Error: " + result.getErrorMsg());
} else {
    log.info("OK: " + result.getIssueId()");
}

ParamImportRegfiaEntry

La clase ParamImportRegfiaEntry encapsula los parametros del asiento de REGFIA que son necesario para realizar la importacion en BENT tal y como los devuelve esta aplicacion en el metodo getRegistry.

 Ver detalles

...

Parámetro

...

Tipo

...

Obligatorio

...

Descripción

...

asunto

...

String

...

SI

...

Asunto del asiento a importar

...

codOrganismoDestino

...

String

...

SI

...

codigo del organismo receptor de la importación. Debe ser un codigo valido de SIU

...

codOrganismoOrigen

...

String

...

NO*

...

codigo del organismo origen de la importación

...

dsOrganismoOrigen

...

String

...

NO*

...

descripcion del organismo emisor de la importación

...

numeroRegistro

...

String

...

SI

...

numero de registro del asiento

...

tipoAsiento

...

String

...

SI

...

Debe ser “E” solo se permiten importar asientos de entrada

...

identificadorAgente

...

String

...

NO*

...

identificador del primer interesado del asiento

...

nombreCompletoAgente

...

String

...

NO*

...

nombre completo del primer interesado del asiento

...

csvList

...

List<String>

...

SI

...

listado de csvs del asiento. BENT comprueba y elimina los documentos en estado borrador. En el caso de que todos sean borradores el envio fallará.

( * ) deben introducirse los datos del organismo origen, o del agente interesado obligatoriamente. En cualquier caso estos parametros se deben rellenar siempre con lo que venga informado en el asiento de REGFIA: organismoOrigen e interesados (el primero del listado).

ResultImportRegfiaEntry

...

ResultTrayListExternal resultTrayList = new ResultTrayListExternal();
ParamFindTrayExternal paramTraySearch = new ParamFindTrayExternal();

paramTraySearch.setApplicationId("APP_CODE");
// codigo SIU de bandeja consultada (se ha de tener permisos en el admin de BENT)
paramTraySearch.setReceiverOrgCode(orgCode);
// filtro de estados de envios opcional
List<Integer> filterStates = new ArrayList<Integer>();
filterStates.add(BENTCoreConstants.EventType.SEND);
filterStates.add(BENTCoreConstants.EventType.FORWARD);
filterStates.add(BENTCoreConstants.EventType.ACCEPT);
paramTraySearch.setState(filterStates);

// añadir paginacion opcional
paramTraySearch.setFromIndex(1);
paramTraySearch.setToIndex(10);
paramTraySearch.setAscending(false);
 
resultTrayList = issueManager.getiIssueService().findIssueTrayAppExternal(paramTraySearch);

if (resultTrayList.getErrorCode() != null) {
  if (resultTrayList.getErrorCode().equals(ErrorCode.FIND_ISSUE_EXTERNAL_NO_RECEIVER_ORGCODE)) {
    log.error("El parametro receiverOrgCode ha sido pasado nulo o vacio");
  } else if (resultTrayList.getErrorCode().equals(ErrorCode.FIND_ISSUE_EXTERNAL_ORGCODE_NOT_ALLOWED)) {
    log.error("No existen permisos sobre la bandeja consultada para esta aplicación");
  } else if (resultTrayList.getErrorCode().equals(ErrorCode.FIND_ISSUE_EXTERNAL_STATE_INVALID)) {
    log.error("Alguno de los valores indicados en el filtro de estados es incorrecto");
  } else if (resultTrayList.getErrorCode().equals(ErrorCode.FIND_ISSUE_EXTERNAL_PAGIN_PARAMS)) {
    log.error("Los parametros de paginacion no han sido introducidos correctamente");
  }
} else {
  log.info("Consulta realizada con exito. Envios devueltos: " + result.getList().size() + " - total de la consulta: " + result.getSize());
}

ParamFindTrayExternal

La clase ParamFindTrayExternal es la que contiene los parámetros para la obtención de los listados de consulta para aplicaciones externas

 Ver detalles

ResultTrayListExternal

La clase ResultTrayListExternal contiene el resultado de la búsqueda.

 Ver detalles

...

FindSentTrayListAdvanced

Método que devuelve una lista de envíos correspondientes de con la bandeja de recibidos enviados con filtros avanzadosadicionales

Signatura

public ResultTrayListAdvanced findIssueTrayResultSentTrayAdvanced findSentTrayListAdvanced(ParamFindTrayAdvanced ParamFindTrayListAdvanced paramTraySearch) throws InternalCoreException

Parámetros de entrada

Parámetros de salida

Excepciones

Ejemplo de invocación

ResultSentTrayAdvanced resultSentTray = new ResultSentTrayAdvanced();
ResultTrayListAdvanced resultTrayList = new ResultTrayListAdvanced();

Integer state = null;
ParamFindTrayListAdvanced paramFindTray =

 new ParamFindTrayListAdvanced();
 

paramFindTray.setIssueId(Long.parseLong(issueId));

paramFindTray.setFromIndex(-1)

;
paramFindTray.setUserSentNif(user.getNif());
paramFindTray.setUserOrgCode(user.getOrganismCode());
 
resultSentTray = issueManager.getiIssueService().findSentTrayListAdvanced(paramFindTray);
 
if (resultSentTray.getSentTrayList() != null) {
    state = resultSentTray.getSentTrayList().get(0).getState();
}

ParamFindTrayAdvanced

La clase ParamFindTrayAdvanced es la que contiene los parámetros para la obtención de los listados que se muestran en las bandejas que ve el usuario, se la bandeja de usuario o la de organismo, tanto para entrada como para salida, con filtros adicionales.

 Ver detalles

ResultTrayListAdvanced

La clase ResultTrayListAdvanced contiene el resultado de buscar la lista de trazas de un envío.

 Ver detalles

...

Parámetro

...

Tipo

...

Descripción

...

list

...

List<ParamReceivedTrayAdvanced>

...

Lista que contiene uno o varios objetos ParamReceivedTrayAdvanced

...

size

...

int

...

Número de objetos que contiene la lista

ParamReceivedTrayAdvanced

La clase ParamReceivedTrayAdvanced contiene los datos a mostrar en el listado de la bandeja de recibidos.

 Ver detalles

ResultSentTrayAdvanced

La clase ResultSentTrayAdvanced contiene el resultado de buscar la lista de trazas de un envío.

 Ver detalles

ParamSentTrayAdvanced

La clase ParamSentTrayAdvanced contiene los datos a mostrar en el listado de la bandeja de enviados. Sus datos son los siguientes:

 Ver detalles

FindSentTrayListAdvanced

...

FindRegfiaIssuesAdvanced

Este método recupera el listado de envíos de REGFIA con filtros y parametros adicionales

Signatura

public ResultSentTrayAdvanced findSentTrayListAdvanced(ParamFindTrayAdvanced paramTraySearch) throws InternalCoreExceptionResultFindRegfiaIssuesAdvanced findRegfiaIssues(ParamFindRegfiaIssuesAdvanced paramFindRegfiaIssues)

Parámetros de entrada

Parámetros de salida

...

Parámetro

...

Tipo

...

Descripción

...

resultSentTray

...

ResultSentTrayAdvanced

...

Objeto donde se encuentran encapsulados la lista de envíos correspondientes a la bandeja y su tamaño

Excepciones

Parámetros de salida

Ejemplo de invocación

ParamFindRegfiaIssuesAdvanced 

paramFindRegfiaIssues =

 new ParamFindRegfiaIssuesAdvanced();

 
paramFindRegfiaIssues.setApplicationId(BENTCoreConstants.BENT);
paramFindRegfiaIssues.setImportRegfiaIssues(BENTCoreConstants.ISSUE_IMPORTED_FROM_REGFIA);
paramFindRegfiaIssues.setOrganismCodeSearch(orgCode);
paramFindRegfiaIssues.setIssueId(issueIdAux);
paramFindRegfiaIssues.setRegistryNumber(filterNumRegister);
// para filtrar importaciones de REGFIA
paramFindRegfiaIssues.setImportRegfiaIssues(BENTCoreConstants.ISSUE_IMPORTED_FROM_REGFIA);
paramFindRegfiaIssues.setSirIssues(null);
 
ResultFindRegfiaIssuesAdvanced resultFindRegfiaIssues = new ResultFindRegfiaIssuesAdvanced();
regfiaIssueList = new ArrayList<>();
resultFindRegfiaIssues = issueManager.getiIssueService().

findRegfiaIssuesAdvanced(

paramFindRegfiaIssues);

if (resultFindRegfiaIssues != null && resultFindRegfiaIssues.getListRegfiaIssues() != null && !resultFindRegfiaIssues.getListRegfiaIssues().isEmpty()) {

    regfiaIssueList = 

resultFindRegfiaIssues.

getListRegfiaIssues()

...

La clase ParamFindTrayAdvanced es la que contiene los parámetros para la obtención de los listados que se muestran en las bandejas que ve el usuario, se la bandeja de usuario o la de organismo, tanto para entrada como para salida, con filtros adicionales.

 Ver detalles

...

Parámetro

...

Tipo

...

Obligatorio

...

Descripción

...

senderDni

...

String

...

NO

...

DNI del remitente

...

senderName

...

String

...

NO

...

Nombre del remitente

...

receiverDni

...

String

...

NO

...

DNI del destinatario

...

receiverName

...

String

...

NO

...

Nombre del destinatario

...

origin

...

String

...

NO

...

Origen de creación del envío

...

adminFileNumber

...

String

...

NO

...

Número del expediente

...

issueId

...

Long

...

NO

...

Identificador del envío

...

status

...

Long

...

NO

...

Estado en el que se encuentra el envío

...

acceptanceNif

...

String

...

NO

...

NIF de la persona que realiza la aceptación del envío

...

description

...

String

...

NO

...

Descripción del envío

...

entryDateFrom

...

Date

...

NO

...

Fecha inicial para el rango de fechas de entrada del envío en el sistema

...

entryDateTo

...

Date

...

NO

...

Fecha final para el rango de fecha de entrada del envío en el sistema

...

receptionDateFrom

...

Date

...

NO

...

Fecha inicial para el rango de fechas de recepción del envío

...

receptionDateTo

...

Date

...

NO

...

Fecha final para el rango de fechas de recepción del envío

...

viewIfIntermediate

...

Boolean

...

NO

...

Incluir o no en el resultado los envíos en los que el organismo es un organismo intermedio en la ruta de remisión

...

fromIndex

...

int

...

NO

...

Para consultas paginadas recuperar desde el registro con el número indicado en fromIndex

...

toIndex

...

int

...

NO

...

Para consultas paginadas recuperar hasta el registro con el número indicado en toIndex

...

maxResults

...

int

...

NO

...

Para consultas paginadas indica el número máximo de registros a retornar

...

sortColumn

...

String

...

NO

...

Columna por la cual se van a ordenar los resultados

...

ascending

...

Boolean

...

NO

...

Ordenación ascendente (true) o descendente (false) de los resultados

...

userSentNif

...

String

...

NO

...

NIF del usuario que realiza el envío, aplicable sólo para envíos remitidos a otro usuario/organismo

...

userOrgCode

...

String

...

NO

...

Código del organismo desde el que se realiza el envío, aplicable sólo para envíos remitidos a otro usuario/organismo

...

acceptedIssue

...

String

...

NO

...

Estado de aceptación de un envío

...

editableDocs

...

String

...

NO

...

Documentos que hay que editar el código de procedimiento

...

origen

...

String

...

NO

...

Parámetro que indica el origen del envío

...

procNum

...

Long

...

NO

...

Codigo de procedimiento

...

eventCause

...

Long

...

NO

...

Causa del evento del envio

...

regInNumber

...

String

...

NO

...

Numero de registro de entrada

...

regOutNumber

...

String

...

NO

...

Numero de registro de salida

...

regInDateFrom

...

Date

...

NO

...

Fecha de registro de entrada

...

regOutDateFrom

...

Date

...

NO

...

Fecha de registro de salida

...

regInCsv

...

String

...

NO

...

Csv del documento de registro de entrada

...

regOutCsv

...

String

...

NO

...

Csv del documento de registro de salida

ResultSentTrayAdvanced

La clase ResultSentTrayAdvanced contiene el resultado de buscar la lista de trazas de un envío.

 Ver detalles

...

Parámetro

...

Tipo

...

Descripción

...

list

...

List<ParamSentTrayAdvanced>

...

Lista que contiene uno o varios objetos ParamSentTrayAdvanced

...

size

...

int

...

Número de objetos que contiene la lista

ParamSentTrayAdvanced

...

;
} else {
    log.info("No se ha recuperado ningún envío");
}

ParamFindRegfiaIssuesAdvanced

La clase ParamFindRegfiaIssuesAdvanced contiene los parametros de una importación de REGFIA

Ver detalles

( * ) Obligatorio informar uno de los dos parametros con el valor correspondiente.

ResultFindRegfiaIssuesAdvanced

La clase ResultFindRegfiaIssues se utiliza para indicar los valores de los filtros que se van a aplicar a la consulta de envíos DIR3

 Ver detalles

FindIssueDetailByEventAdvanced

Este método recupera los detalles de un envío dados el identificador del envio y un evento en concreto. Esta ideado para visualizar la informacion de un envio segun el estado del mismo afectando a una bandeja en concreto, dicho de otra manera esta pensado para ser invocado con los datos que devuelven los metodos de consulta de bandeja que se detallan mas arriba.

Signatura

public ResultFindIssueDetailAdvanced findIssueDetailbyEventAdvanced(ParamFindIssueAdvanced paramFindIssue) throws InternalCoreException {

Parámetros de entrada

Parámetros de salida

Ejemplo de invocación

ParamFindIssueAdvanced paramFindIssueAdvanced= new ParamFindIssueAdvanced();
 
paramFindIssueAdvanced.setApplicationId(BENTCoreConstants.BENT);
paramFindIssueAdvanced.setIssueId(issueId);
paramFindIssueAdvanced.setIssueEventId(issueEventId);
paramFindIssueAdvanced.setFindIssueEvents(true);
paramFindIssueAdvanced.setFindIssueTrace(false);
 
ResultFindIssueDetailAdvanced resultFindIssueDetailAdvanced = new ResultFindIssueDetailAdvanced ();
resultFindIssueDetailAdvanced = issueManager.getiIssueService().findIssueDetailbyEventAdvanced(paramFindIssueAdvanced);

ParamFindIssueAdvanced

La clase ParamFindIssueAdvanced contiene los parametros de busqueda del envío

Ver detalles

ResultFindIssueDetailAdvanced

La clase ResultFindIssueDetailAdvanced se utiliza para indicar los valores del envio correspondiente

 Ver detalles

FindRegfiaIssueByRegfiaCodeAdvanced

Este método recupera una importación de REGFIA a través de su identificador obteniendo parametros extendidos como el numero de procedimiento.

Signatura

public ResultRegfiaIssueAdvanced findRegfiaIssueByRegfiaCodeAdvanced(ParamRegfiaIssueAdvanced paramRegfiaIssue) throws InternalCoreException {

Parámetros de entrada

Parámetros de salida

Ejemplo de invocación

ParamRegfiaIssueAdvanced paramRegfiaIssue = new ParamRegfiaIssueAdvanced();
paramRegfiaIssue.setRegfiaCode("E20190000404");
ResultRegfiaIssueAdvanced result = issueService.findRegfiaIssueByRegfiaCodeAdvanced(paramRegfiaIssue);

ParamRegfiaIssueAdvanced

La clase ParamRegfiaIssueAdvanced contiene los parametros de busqueda del asiento importado

Ver detalles

ResultRegfiaIssueAdvanced

La clase ResultRegfiaIssueAdvanced se utiliza para indicar los valores de la importación correspondiente

 Ver detalles

FindRegfiaIssuesAdvanced

Este método recupera el listado de envíos de REGFIA con filtros y parametros adicionales

Signatura

public ResultFindRegfiaIssuesAdvanced findRegfiaIssues(ParamFindRegfiaIssuesAdvanced paramFindRegfiaIssues)

Parámetros de entrada

...

Parámetro

...

Tipo

...

Obligatorio

...

Descripción

...

paramFindRegfiaIssues

...

ParamFindRegfiaIssuesAdvanced

...

SI

...

Objeto que contiene los valores de los filtros que se van a aplicar a la consulta de envíos DIR3

Parámetros de salida

...

Parámetro

...

Tipo

...

Descripción

...

resultFindRegfiaIssues

...

ResultFindRegfiaIssuesAdvanced

...

Objeto que contiene el listado de envíos

Ejemplo de invocación

...

ParamFindRegfiaIssuesAdvanced paramFindRegfiaIssues = new ParamFindRegfiaIssuesAdvanced();
 
paramFindRegfiaIssues.setApplicationId(BENTCoreConstants.BENT);
paramFindRegfiaIssues.setImportRegfiaIssues(BENTCoreConstants.ISSUE_IMPORTED_FROM_REGFIA);
paramFindRegfiaIssues.setOrganismCodeSearch(orgCode);
paramFindRegfiaIssues.setIssueId(issueIdAux);
paramFindRegfiaIssues.setRegistryNumber(filterNumRegister);
// para filtrar importaciones de REGFIA
paramFindRegfiaIssues.setImportRegfiaIssues(BENTCoreConstants.ISSUE_IMPORTED_FROM_REGFIA);
paramFindRegfiaIssues.setSirIssues(null);
 
ResultFindRegfiaIssuesAdvanced resultFindRegfiaIssues = new ResultFindRegfiaIssuesAdvanced();
regfiaIssueList = new ArrayList<>();
resultFindRegfiaIssues = issueManager.getiIssueService().findRegfiaIssuesAdvanced(paramFindRegfiaIssues);
if (resultFindRegfiaIssues != null && resultFindRegfiaIssues.getListRegfiaIssues() != null && !resultFindRegfiaIssues.getListRegfiaIssues().isEmpty()) {
    regfiaIssueList = resultFindRegfiaIssues.getListRegfiaIssues();
} else {
    log.info("No se ha recuperado ningún envío");
}

...

FindIssueEventByIssueIdAdvanced

Este método recupera los eventos asociados a un envio a traves de su id con información extendida.

Signatura

public List<ParamIssueEventAdvanced> findIssueEventByIssueIdAdvanced(ParamFindIssueAdvanced paramFindIssue) throws InternalCoreException {

Parámetros de entrada

Parámetros de salida

Ejemplo de invocación

ParamFindIssueAdvanced paramFindIssue = new ParamFindIssueAdvanced();
paramFindIssue.setIssueId(IssueID);
List<ParamIssueEventAdvanced> result = issueService.findIssueEventByIssueIdAdvanced(paramFindIssue);		

ParamFindIssueAdvanced

La clase ParamFindIssueAdvanced contiene los parametros de busqueda del asiento importado

Ver detalles

ParamIssueEventAdvanced

La clase ParamIssueEventAdvanced contiene los parametros de busqueda del evento recuperado

Ver detalles

FindIssueAdvanced

Este método recupera un envío con información extendida.

Signatura

public ParamIssueAdvanced findIssueAdvanced(ParamFindIssueAdvanced paramFindIssue) throws InternalCoreException {

Parámetros de entrada

Parámetros de salida

Ejemplo de invocación

ParamFindIssueAdvanced paramIssueId = new ParamFindIssueAdvanced();
paramIssueId.setIssueId(IssueID);
paramIssueId.setFindIssueEvents(false);
ParamIssueAdvanced result = issueService.findIssueAdvanced(paramIssueId);

ParamFindIssueAdvanced

La clase ParamFindIssueAdvanced contiene los parametros de busqueda del asiento importado

Ver detalles

ParamIssueAdvanced

La clase ParamIssueAdvanced contiene los parametros de busqueda del evento recuperado

Ver detalles

FindIssueDetailByEventAdvanced

Este método recupera los detalles de un envío dados el identificador del envio y un evento en concreto. Esta ideado para visualizar la informacion de un envio segun el estado del mismo afectando a una bandeja en concreto, dicho de otra manera esta pensado para ser invocado con los datos que devuelven los metodos de consulta de bandeja que se detallan mas arriba.

Signatura

...

( * ) Obligatorio informar uno de los dos parametros con el valor correspondiente.

ResultFindRegfiaIssuesAdvanced

La clase ResultFindRegfiaIssues se utiliza para indicar los valores de los filtros que se van a aplicar a la consulta de envíos DIR3

 Ver detalles

...

Parámetro

...

Tipo

...

Descripción

...

listRegfiaIssues

...

List<ParamFindRegfiaIssuesAdvanced>

...

Lista con los valores de los filtros que se van a aplicar a la consulta de envíos DIR3

...

size

...

int

...

numero de resultados devueltos

Servicio OrganismManagerService

...

GetEmailListByOrgCode

Este método del servicio organismManager permite recuperar el listado de los emails de los usuarios dados de alta en BENT en una bandeja de organismo concreta. BENT únicamente almacena los dnis de los usuarios en su base de datos, recuperando el email a través de SIU. Si un usuario implicado en la búsqueda no tuviera un email registrado el servicio simplemente no lo añadirá al listado de resultados.

Signatura

public List<String> getEmailListByOrgCode(ParamOrganismManager paramOrganismManager) throws InternalCoreException

Parámetros de entrada

Parámetros de salida

Ejemplo de invocación

...

ParamFindIssueAdvanced paramFindIssueAdvanced= new ParamFindIssueAdvanced();
 
paramFindIssueAdvanced.setApplicationId(BENTCoreConstants.BENT);
paramFindIssueAdvanced.setIssueId(issueId);
paramFindIssueAdvanced.setIssueEventId(issueEventId);
paramFindIssueAdvanced.setFindIssueEvents(true);
paramFindIssueAdvanced.setFindIssueTrace(false);
 
ResultFindIssueDetailAdvanced resultFindIssueDetailAdvanced = new ResultFindIssueDetailAdvanced ();
resultFindIssueDetailAdvanced = issueManager.getiIssueService().findIssueDetailbyEventAdvanced(paramFindIssueAdvanced);

ParamFindIssueAdvanced

...

Ver detalles

...

Parámetro

...

Tipo

...

Obligatorio

...

Descripción

...

issueId

...

Long

...

SI

...

identidicador del envío

...

issueEventId

...

Long

...

SI

...

identificador del evento del envío

...

findIssueEvents

...

Boolean

...

SI

...

indica si se quieren recuperar los eventos del envio

...

findIssueTrace

...

Boolean

...

SI

...

indica si se quieren recuperar las trazas del envío

ResultFindIssueDetailAdvanced

La clase ResultFindIssueDetailAdvanced se utiliza para indicar los valores del envio correspondiente

 Ver detalles

...

Parámetro

...

Tipo

...

Descripción

...

issueEventId

...

Long

...

identificador del evento

...

issueId

...

Long

...

identificador del envio

...

description

...

String

...

descripcion del envio

...

origin

...

String

...

origen del envio

...

state

...

String

...

estado del envio

...

originalSender

...

ParamIssueEvent

...

evento original del envío

...

previousSender

...

ParamIssueEvent

...

evento anterior al consultado

...

lastSender

...

ParamIssueEvent

...

evento ultimo del envio

...

pararmIssueEvent

...

ParamIssueEvent

...

evento consultado

...

procNum

...

Long

...

numero de procedimiento del envío

Servicio OrganismManagerService

GetEmailListByOrgCode

...

Ejemplo de invocación

ParamOrganismManager paramOrganismManager = new ParamOrganismManager();

// el id de aplicacion se rellena automaticamente si esta configurado el interceptor de autorización de salida, si no se ha de indicar
paramOrganismManager.setApplicationId("SETA");
// indicamos un codigo de organismo
paramOrganismManager.setOrgCode("ORG06670");
 
List<String> result = bentOrganismManagerClient.getEmailListByOrgCode(paramOrganismManager);
 
if (result == null || result.size() == 0) {
  log.info("No se encontraron gestores asociados con el organismo");
} else {
  for (String managerEmail: result) {
    log.info("Encontrado email de gestor: " + managerEmail");
  }
}

getOrganismManagerListByOrgCode

Este método del servicio organismManager permite recuperar el listado de gestores asociados en BENT con un código de organismo concreto.

Signatura

public List<ParamOrganismManager> getOrganismManagerListByOrgCode(ParamOrganismManager paramOrganismManager) throws InternalCoreException

Parámetros de entrada

Parámetros de salida

Ejemplo de invocación

ParamOrganismManager paramOrganismManager = new ParamOrganismManager();

// el id de aplicacion se rellena automaticamente si esta configurado el interceptor de autorización de salida, si no se ha de indicar
paramOrganismManager.setApplicationId("AGUAE");
// indicamos un codigo de organismo
paramOrganismManager.setOrgCode("ORG06670");
 
List<ParamOrganismManager> result = bentOrganismManagerClient.getOrganismManagerListByOrgCode(paramOrganismManager);
 
if (result == null || result.size() == 0) {
  log.info("No se encontraron gestores asociados con el organismo");
} else {
  for (ParamOrganismManager manager : result) {
    log.info("Encontrado gestor con dni " + manager.getManagerDni() + " e id de gestor " + manager.getOrganismManagerId() + " en el organismo");
  }
}