notificaciones.cliente.api
Class MCSN

java.lang.Object
  |
  +--notificaciones.cliente.api.MCSN

public class MCSN
extends java.lang.Object


Constructor Summary
MCSN(java.util.Properties paramConf, boolean log)
          Constructor de la clase
MCSN(java.lang.String pathArchivoConfig, boolean log)
          Constructor de la clase
 
Method Summary
 int enviarRemesa(Remesa remesa)
          Permite enviar una remesa de notificaciones al Sistema de Notificaciones
 RemesaInf[] obtenerInfRemesa(java.util.Date fechaIni, java.util.Date fechaFin, int cod_Suscripcion)
          Através del siguiente método se puede obtener información de las remesas entregadas al Sistema de Notificaciones y procesadas por el mismo entre una fecha inicial y final, y asociadas a una suscripción concreta.
 RemesaInf[] obtenerInfRemesa(java.util.Date fechaIni, java.util.Date fechaFin, int cod_Servicio, Abonado[] abonados)
          A través del siguiente método se puede obtener información acerca de las remesas que continene notificaciones destinadas a un grupo de abonados.
 RemesaInf[] obtenerInfRemesaConNotifLeidas(java.util.Date fechaIni, java.util.Date fechaFin, int cod_Suscripcion)
          A través del siguiente método se puede obtener información de las remesas entregadas al Sistema de Notificaciones y procesadas por el mismo entre una fecha inicial y final, y asociadas a una suscripción concreta, que contienen información de notificaciones leídas por sus receptores.
 RemesaInf[] obtenerInfRemesaConNotifNoLeidas(java.util.Date fechaIni, java.util.Date fechaFin, int cod_Suscripcion, boolean rechazados)
          A través del siguiente método se puede obtener información de las remesas entregadas al Sistema de Notificaciones y procesadas por el mismo entre una fecha inicial y final, y asociadas a una suscripción concreta, que contienen información de notificaciones no leídas por sus receptores.
 RemesaInf[] obtenerInfRemesas(int[] remesas, boolean conAcuses)
          Devuelve información acerca de una o un conjunto de remesas enviadas anteriormente al Sistema de Notificaciones
 void solicitarAltaAbonado(Abonado abonado, FirmaInf firma, int cod_Servicio)
          Solicita el alta de un abonado a un servicio asociado.
 void solicitarBajaAbonado(Abonado abonado, int cod_Servicio)
          Permite solicitar la baja de un Abonado de un servicio.
 CertificadoInf[] solicitarCertificadoAbonados(java.lang.String[] anagramasAbons)
          Permite buscar el certificado asociado a un conjunto de usuarios dados de alta en Notific@.
 int[] solicitarEstadoAbonadosServicio(java.lang.String[] anagramasAbons, int cod_Servicio)
          Verifica si un conjunto de usuarios están dados de alta en Notifica y suscritos a un servicio.
 AbonadoInf[] solicitarInformacionAltasIniciativaAbonado(java.util.Date fechaIni, java.util.Date fechaFin, int cod_Servicio)
          Devuelve el conjunto de Abonados que se han dado de alta por iniciativa propia a un Servicio entre una fecha inicial y final.
 AbonadoInf[] solicitarInformacionBajasAbonado(java.util.Date fechaIni, java.util.Date fechaFin, int cod_Servicio)
          Devuelve el conjunto de Abonados que se han dado de baja de un Servicio entre una fecha inicial y final.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MCSN

public MCSN(java.util.Properties paramConf,
            boolean log)
     throws java.lang.Exception
Constructor de la clase

Parameters:
paramConf - Properties que contiene la configuración del módulo Cliente del Sistema de Notificaciones (mcsn.properties)
log - true el API es capaz de configurar el LOG4j, false el API configurará el LOG4J

MCSN

public MCSN(java.lang.String pathArchivoConfig,
            boolean log)
     throws java.lang.Exception
Constructor de la clase

Parameters:
pathArchivoConfig - Ruta absoluta hacia el archivo de configuración del Módulo Cliente del Sistema de Notificaciones
log - true el API es capaz de configurar el LOG4j, false el API configurará el LOG4J
Method Detail

enviarRemesa

public int enviarRemesa(Remesa remesa)
                 throws notificaciones.cliente.excepciones.MCSNException
Permite enviar una remesa de notificaciones al Sistema de Notificaciones

Parameters:
remesa - Conjunto de notificaciones
Returns:
int Identificador de remesa generado por el Sistema de Notificaciones
Throws:
notificaciones.cliente.excepciones.MCSNException

solicitarAltaAbonado

public void solicitarAltaAbonado(Abonado abonado,
                                 FirmaInf firma,
                                 int cod_Servicio)
                          throws notificaciones.cliente.excepciones.MCSNException
Solicita el alta de un abonado a un servicio asociado. Como es de suponer este código de servicio debe haber sido proporcionado por el Administrador del Sistema de Notificaciones una vez creado el servicio

Parameters:
abonado - Abonado a dar de alta en el servicio
firma - Firma electrónica realizada por el Usuario en el momento de la aceptación de la recepción de notificaciones por vía telemática según el Real Decreto 209/2003.
cod_Servicio - Identificador del servicio donde se quiere dar de alta al abonado
Throws:
notificaciones.cliente.excepciones.MCSNException

solicitarEstadoAbonadosServicio

public int[] solicitarEstadoAbonadosServicio(java.lang.String[] anagramasAbons,
                                             int cod_Servicio)
                                      throws notificaciones.cliente.excepciones.MCSNException
Verifica si un conjunto de usuarios están dados de alta en Notifica y suscritos a un servicio.

Parameters:
cod_Servicio - Identificador del servicio donde se quiere comprobar si los usuarios están suscritos o no
Returns:
int[] Por cada usuario,devuelve: '-1' si el usuario no está dado de alta en el sistema '0' si el usuario no está dado de alta en el servicio y si en el sistema '1' si el usuario ESTA dado de alta en el servicio.
Throws:
notificaciones.cliente.excepciones.MCSNException

solicitarCertificadoAbonados

public CertificadoInf[] solicitarCertificadoAbonados(java.lang.String[] anagramasAbons)
                                              throws notificaciones.cliente.excepciones.MCSNException
Permite buscar el certificado asociado a un conjunto de usuarios dados de alta en Notific@.

Returns:
CertificadoInf[] Certificados de los usuarios indicados.
Throws:
notificaciones.cliente.excepciones.MCSNException

solicitarBajaAbonado

public void solicitarBajaAbonado(Abonado abonado,
                                 int cod_Servicio)
                          throws notificaciones.cliente.excepciones.MCSNException
Permite solicitar la baja de un Abonado de un servicio. Como es de suponer este código de servicio debe haber sido proporcionado por el Administrador del Sistema de Notificaciones una vez creado el servicio

Parameters:
abonado -
cod_Servicio - Identificador del servicio donde se quiere dar de alta al abonado
Throws:
notificaciones.cliente.excepciones.MCSNException

solicitarInformacionAltasIniciativaAbonado

public AbonadoInf[] solicitarInformacionAltasIniciativaAbonado(java.util.Date fechaIni,
                                                               java.util.Date fechaFin,
                                                               int cod_Servicio)
                                                        throws notificaciones.cliente.excepciones.MCSNException
Devuelve el conjunto de Abonados que se han dado de alta por iniciativa propia a un Servicio entre una fecha inicial y final.

notificaciones.cliente.excepciones.MCSNException

solicitarInformacionBajasAbonado

public AbonadoInf[] solicitarInformacionBajasAbonado(java.util.Date fechaIni,
                                                     java.util.Date fechaFin,
                                                     int cod_Servicio)
                                              throws notificaciones.cliente.excepciones.MCSNException
Devuelve el conjunto de Abonados que se han dado de baja de un Servicio entre una fecha inicial y final.

notificaciones.cliente.excepciones.MCSNException

obtenerInfRemesas

public RemesaInf[] obtenerInfRemesas(int[] remesas,
                                     boolean conAcuses)
                              throws notificaciones.cliente.excepciones.MCSNException
Devuelve información acerca de una o un conjunto de remesas enviadas anteriormente al Sistema de Notificaciones

Parameters:
remesas - Conjunto de identificadores de remesas sobre las cuales se quiere obtener información.
conAcuses - Indica si la información acerca de una o un conjunto de remesas debe ir o no con Acuses generados por el sistema (Acuse de Admisión de Remesa, Acuse puesta a disposición de la notificación y Acuse de Recibo de la notificación).
Returns:
RemesaInf[]
Throws:
notificaciones.cliente.excepciones.MCSNException

obtenerInfRemesaConNotifNoLeidas

public RemesaInf[] obtenerInfRemesaConNotifNoLeidas(java.util.Date fechaIni,
                                                    java.util.Date fechaFin,
                                                    int cod_Suscripcion,
                                                    boolean rechazados)
                                             throws notificaciones.cliente.excepciones.MCSNException
A través del siguiente método se puede obtener información de las remesas entregadas al Sistema de Notificaciones y procesadas por el mismo entre una fecha inicial y final, y asociadas a una suscripción concreta, que contienen información de notificaciones no leídas por sus receptores.

Parameters:
fechaIni - Fecha Inicio del rango de fechas de procesamiento de remesas
fechaFin - Fecha Fin del rango de fechas de procesamiento de remesas
cod_Suscripcion - Identificador único de la suscripción
rechazados - Indica si se quiere obtener solo aquellas notificaciones que no han sido leidas por el receptor durante el plazo indicado de 10 dias naturales en el Real Decreto 209/2003 o han sido rechazadas explicitamente por el receptor.
Returns:
RemesaInf[]
Throws:
notificaciones.cliente.excepciones.MCSNException

obtenerInfRemesaConNotifLeidas

public RemesaInf[] obtenerInfRemesaConNotifLeidas(java.util.Date fechaIni,
                                                  java.util.Date fechaFin,
                                                  int cod_Suscripcion)
                                           throws notificaciones.cliente.excepciones.MCSNException
A través del siguiente método se puede obtener información de las remesas entregadas al Sistema de Notificaciones y procesadas por el mismo entre una fecha inicial y final, y asociadas a una suscripción concreta, que contienen información de notificaciones leídas por sus receptores.

Parameters:
fechaIni - Fecha Inicio del rango de fechas de procesamiento de remesas
fechaFin - Fecha Fin del rango de fechas de procesamiento de remesas
cod_Suscripcion - Identificador único de la suscripción
Returns:
RemesaInf[]
Throws:
notificaciones.cliente.excepciones.MCSNException

obtenerInfRemesa

public RemesaInf[] obtenerInfRemesa(java.util.Date fechaIni,
                                    java.util.Date fechaFin,
                                    int cod_Suscripcion)
                             throws notificaciones.cliente.excepciones.MCSNException
Através del siguiente método se puede obtener información de las remesas entregadas al Sistema de Notificaciones y procesadas por el mismo entre una fecha inicial y final, y asociadas a una suscripción concreta.

Parameters:
fechaIni - Fecha Inicio del rango de fechas de procesamiento de remesas
fechaFin - Fecha Fin del rango de fechas de procesamiento de remesas
cod_Suscripcion - Identificador único de la suscripción
Returns:
RemesaInf[]
Throws:
notificaciones.cliente.excepciones.MCSNException

obtenerInfRemesa

public RemesaInf[] obtenerInfRemesa(java.util.Date fechaIni,
                                    java.util.Date fechaFin,
                                    int cod_Servicio,
                                    Abonado[] abonados)
                             throws notificaciones.cliente.excepciones.MCSNException
A través del siguiente método se puede obtener información acerca de las remesas que continene notificaciones destinadas a un grupo de abonados.

Parameters:
fechaIni - Fecha de inicio a partir de la cual se generaron los Acuses
fechaFin - Hasta que fecha se quieren los Acuses.
cod_Servicio - Identificador del servicio
abonados - Abonados sobre los cuales se quiere obtener los acuses
Returns:
RemesaInf[] Información de remesas procesadas por el Sistema
Throws:
notificaciones.cliente.excepciones.MCSNException