Interface MonitoraggioApi

public interface MonitoraggioApi
Raccoglie i conteggi trimestrali delle OPT e le schede personali degli operatori del Banco. I dati descrivono attività dichiarate e sono indipendenti dal ciclo della singola richiesta.

  • Method Details

    • registraConteggiOpt

      void registraConteggiOpt(UtenzeApi.IdentitaAutenticata attore, MonitoraggioApi.Trimestre trimestre, List<MonitoraggioApi.VoceMisura> conteggi)
      Registra i conteggi della OPT autenticata per il trimestre. Lo stesso valore ritrasmesso per OPT, trimestre, misura e voce compare una sola volta nei riepiloghi. Un valore diverso può sostituirlo secondo le regole vigenti per le correzioni.
      Parameters:
      attore - identità verificata della OPT titolare
      trimestre - trimestre a cui si riferiscono le attività
      conteggi - voci dichiarate per le misure svolte
      Throws:
      SecurityException - se l'attore non è una OPT autorizzata
      IllegalArgumentException - se le voci o i riferimenti alle misure sono invalidi
      IllegalStateException - se il periodo o il dato esistente non consentono l'aggiornamento

    • consultaConteggiOpt

      List<MonitoraggioApi.ConteggioOpt> consultaConteggiOpt(UtenzeApi.IdentitaAutenticata attore, UUID optId, MonitoraggioApi.Trimestre da, MonitoraggioApi.Trimestre a)
      Consulta i conteggi dichiarati, per un singolo trimestre o cumulati sui trimestri inclusi. Il cumulativo somma la stessa voce per OPT e misura. Una voce mai dichiarata nel periodo è assente, mentre uno zero dichiarato è un valore. Le categorie sovrapponibili restano distinte.
      Parameters:
      attore - identità verificata della OPT titolare o del Banco autorizzato
      optId - account della OPT da consultare oppure null per tutte le OPT, riservato al Banco
      da - primo trimestre incluso nel periodo
      a - ultimo trimestre incluso, uguale a da per la vista trimestrale
      Returns:
      voci con un valore dichiarato nel periodo, eventualmente nessuna
      Throws:
      SecurityException - se l'attore non è autorizzato alla vista richiesta
      IllegalArgumentException - se il periodo è invertito
      NoSuchElementException - se l'account OPT richiesto non esiste

    • inviaSchedaOperatore

      UUID inviaSchedaOperatore(UtenzeApi.IdentitaAutenticata attore, MonitoraggioApi.Trimestre trimestre, MonitoraggioApi.DatiSchedaOperatore dati)
      Invia la scheda personale trimestrale dell'operatore autenticato. Il modulo ricava il titolare dall'identità verificata. Il tracciato e le regole di firma e correzione seguono il raffinamento della storia di compilazione.
      Parameters:
      attore - identità verificata dell'operatore interno o esterno pagato dal Banco
      trimestre - periodo di rendicontazione
      dati - dati dichiarati nella scheda personale
      Returns:
      identificativo della scheda ricevuta
      Throws:
      SecurityException - se l'attore non è un operatore autorizzato
      IllegalArgumentException - se i dati non rispettano il tracciato applicabile
      IllegalStateException - se il periodo o la scheda esistente non consentono un nuovo invio

    • elencoSchedeOperatore

      List<MonitoraggioApi.SchedaSintesi> elencoSchedeOperatore(UtenzeApi.IdentitaAutenticata attore)
      Elenca le schede personali inviate dall'operatore autenticato.
      Parameters:
      attore - identità verificata dell'operatore titolare
      Returns:
      riferimenti alle proprie schede
      Throws:
      SecurityException - se l'attore non è un operatore autorizzato

    • consultaSchedaOperatore

      MonitoraggioApi.SchedaOperatore consultaSchedaOperatore(UtenzeApi.IdentitaAutenticata attore, UUID schedaId)
      Consulta la scheda personale. Il Banco può leggerla per la rendicontazione e l'operatore titolare può consultare la propria.
      Parameters:
      attore - identità verificata del Banco autorizzato o dell'operatore titolare
      schedaId - identificativo della scheda
      Returns:
      scheda personale visibile all'attore
      Throws:
      SecurityException - se l'attore non può consultare la scheda
      NoSuchElementException - se la scheda non esiste

    • riepilogaSchede

      MonitoraggioApi.RiepilogoTrimestre riepilogaSchede(UtenzeApi.IdentitaAutenticata attore, MonitoraggioApi.Trimestre trimestre)
      Riepiloga per il Banco le schede ricevute nel trimestre selezionato. Le voci aggregate rappresentano conteggi dichiarati e conservano distinte le categorie sovrapponibili.
      Parameters:
      attore - identità verificata del Banco autorizzato alla rendicontazione
      trimestre - singolo trimestre da riepilogare
      Returns:
      riferimenti alle schede ricevute e totali per voce, anche in assenza di invii
      Throws:
      SecurityException - se l'attore non è autorizzato al riepilogo