GestioneDocumenti |
- Description:
|
Operation Summary
|
Returns |
Method |
String
|
creaFascicolo(String registro, String codiceTitolario, String codiceInterno, String descrizione, List<Organizzazione> assegnatari)
Crea un nuovo fascicolo: il nome del fascicolo e' composto col codice dell'ufficio in base alle regole stabilite dall'Uffcio Organizzazione. Il codiceInterno, se presente, puo' essere lungo al massimo 20 caratteri
|
void
|
associaProtocolloAFascicolo(String registro, String codiceFascicolo, String numeroProtocollo, Integer anno)
Inserisce un Protocollo in un fascicolo gia' esistente
|
void
|
togliProtocolloDaFascicolo(String registro, String codiceFascicolo, String numeroProtocollo, Integer anno)
Rimuove da un Fascicolo un Protocollo precedentemente associato
|
void
|
chiudiFascicolo(String registro, String codiceFascicolo)
Chiude un fascicolo: in questo modo non sara' possibile aggiungere nuovi protocolli o nuovi documenti
|
String
|
creaProtocollo(String registro, Protocollo protocollo, List<String> codiceFascicoli, List<Organizzazione> assegnatariPerCompetenzaList, List<Organizzazione> assegnatariPerConoscenzaList)
Crea un nuovo Protocollo con i dati forniti, e restiutuisce il numero di Protocollo generato
|
String
|
creaProtocolloDifferito(String registro, Protocollo protocollo, List<String> codiceFascicoli, List<Organizzazione> assegnatariPerCompetenzaList, List<Organizzazione> assegnatariPerConoscenzaList)
Crea un nuovo Protocollo differito con i dati forniti, e restiutuisce il numero di Protocollo generato. Richiede anche il numero di protocollo della autorizzazione al differimento
|
void
|
modificaProtocollo(String registro, Protocollo protocollo, Integer anno, List<String> codiceFascicoli, List<Organizzazione> assegnatariPerCompetenzaList, List<Organizzazione> assegnatariPerConoscenzaList)
Permette di modificare alcuni valori di un Protocollo gia' inserito
|
void
|
annullaProtocollo(String registro, String numeroProtocollo, Integer anno, String numeroProtocolloAutorizzazione, Integer annoProtocolloAutorizzazione)
Permette di annullare un Protocollo gia' inserito
|
Protocollo
|
dettaglioProtocollo(String registro, String numeroProtocollo, Integer anno)
Ricupera le informazioni di dettagli riguardanti un Protocollo
|
List<Fascicolo>
|
listaFascicoli(String registro, String codiceTitolario, String codiceFascicolo, String codiceInterno, String descFascicolo, IntervalloData intervalloDataApertura)
Produce la lista dei fascicoli che soddisfano le condizioni specificate
|
List<Protocollo>
|
listaProtocolli(String registro, String numeroProtocollo, String codiceTitolario, String sottoclasse, String codiceFascicolo, String oggetto, MittenteDestinatario mittenteDestinatario, IntervalloData intervalloDataProtocollazione)
Produce la lista di tutti i Protocolli che corrsispondono alle condizioni specificate
|
List<Titolario>
|
listaTitolari(String registro)
Produce la lista di tutti i titolari
|
List<TipoSpedizione>
|
listaTipoSpedizione()
Produce una lista di tutti i tipi di spedizione accettati
|
List<Organizzazione>
|
listaOrganizzazioni(String registro)
Produce una lista di tutte le Organizzazioni
|
Organizzazione
|
dettagliOrganizzazione(String registro, String codice)
Fornisce i dettagli di una Organizzazione in base al suo codice
|
void
|
associaDocumentoPrincipaleAProtocollo(String registro, String numeroProtocollo, Integer anno, Documento documento)
Associa il Documento elettronico principale ad un numero di Protocollo gia' creato
|
Documento
|
downloadDocumentoPrincipale(String registro, String numeroProtocollo, Integer anno)
Download di un documento in formato elettronico registrato nel sistema documentale
|
void
|
associaDocumentoAllegatoAProtocollo(String registro, String numeroProtocollo, Integer anno, Documento documento, String commento)
Associa un Documento elettronico ad un numero di Protocollo gia' creato come allegato
|
Documento
|
downloadDocumentoAllegato(String registro, String numeroProtocollo, Integer anno, String codiceAllegato)
Download di un documento in formato elettronico registrato nel sistema documentale
|
void
|
rimuoviDocumentoAllegatoDaProtocollo(String registro, String numeroProtocollo, Integer anno, String codiceAllegato)
Rimuove un Documento elettronico allegato ad un numero di Protocollo
|
List<Allegato>
|
listaAllegati(String registro, String numeroProtocollo, Integer anno)
lista degli allegati associati ad un protocollo
|
Operation Detail
|
creaFascicolo
-
public String creaFascicolo()
-
Crea un nuovo fascicolo: il nome del fascicolo e' composto col codice dell'ufficio in base alle regole stabilite dall'Uffcio Organizzazione. Il codiceInterno, se presente, puo' essere lungo al massimo 20 caratteri
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String codiceTitolario - Codice del titolario, utilizzato per definire il codice del fascicolo:obbligatorio
- String codiceInterno - Codice interno del fascicolo: non obbligatorio
- String descrizione - Descrizione del Fascicolo
- List<Organizzazione> assegnatari - Lista degli assegnatari
-
Returns:
- String -
-
Throws:
- CodiceTitolarioNonEsistente
- CodiceTitolarioObbligatorio
- CodiceInternoTroppoLungo
- RegistroNonEsistente
- AssegnatarioCompetenzaMancante
- EProcsResponseError
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
associaProtocolloAFascicolo
-
public void associaProtocolloAFascicolo()
-
Inserisce un Protocollo in un fascicolo gia' esistente
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String codiceFascicolo - Codice del Fascicolo in cui inserire il Protocollo
- String numeroProtocollo - Numero di Protocollo da inserire nel fascicolo
- Integer anno - Anno del Protocollo
-
Returns:
- Nothing
-
Throws:
- CodiceFascicoloNonEsistente
- NumeroProtocolloNonEsistente
- EProcsResponseError
- RegistroNonEsistente
- CodiceFascicoloNonCompatibile
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
togliProtocolloDaFascicolo
-
public void togliProtocolloDaFascicolo()
-
Rimuove da un Fascicolo un Protocollo precedentemente associato
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String codiceFascicolo - Codice del Fascicolo in cui inserire il Protocollo
- String numeroProtocollo - Numero di Protocollo da inserire nel fascicolo
- Integer anno - Anno del Protocollo
-
Returns:
- Nothing
-
Throws:
- NumeroProtocolloNonEsistente
- EProcsResponseError
- CodiceFascicoloNonEsistente
- RegistroNonEsistente
- CodiceFascicoloNonCompatibile
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
chiudiFascicolo
-
public void chiudiFascicolo()
-
Chiude un fascicolo: in questo modo non sara' possibile aggiungere nuovi protocolli o nuovi documenti
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String codiceFascicolo - Codice del Fascicolo da chiudere
-
Returns:
- Nothing
-
Throws:
- EProcsResponseError
- CodiceFascicoloNonEsistente
- RegistroNonEsistente
- CodiceFascicoloNonCompatibile
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
creaProtocollo
-
public String creaProtocollo()
-
Crea un nuovo Protocollo con i dati forniti, e restiutuisce il numero di Protocollo generato
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- Protocollo protocollo - Protocollo da creare
- List<String> codiceFascicoli - Codici dei Fascicoli al quale associare il Protocollo: se vuota, il Protocollo non viene associato a nessun fascicolo
- List<Organizzazione> assegnatariPerCompetenzaList - Lista degli assegnatari per competenza: i documenti protocollati vengono assegnati ad una organizzazione e non a una specifica persona
- List<Organizzazione> assegnatariPerConoscenzaList - Lista degli assegnatari per conoscenza
-
Returns:
- String -
-
Throws:
- OggettoDocumentoVuoto
- CodiceFascicoloNonEsistente
- AssegnatarioCompetenzaMancante
- TipoProtocolloNonValido
- DestinatarioCompetenzaMancante
- MittenteNonValido
- TipoSpedizioneNonEsistente
- EProcsResponseError
- DataProtocollazioneNonValida
- RegistroNonEsistente
- CodiceTitolarioNonEsistente
- CodiceTitolarioObbligatorio
- NumeroProtocolloNonEsistente
- MittenteDestinatarioIncompleto
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
creaProtocolloDifferito
-
public String creaProtocolloDifferito()
-
Crea un nuovo Protocollo differito con i dati forniti, e restiutuisce il numero di Protocollo generato. Richiede anche il numero di protocollo della autorizzazione al differimento
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- Protocollo protocollo - Protocollo da creare
- List<String> codiceFascicoli - Codici dei Fascicoli al quale associare il Protocollo: se vuota il Protocollo non viene associato a nessun fascicolo
- List<Organizzazione> assegnatariPerCompetenzaList - Lista degli assegnatari per competenza: i documenti protocollati vengono assegnati ad una organizzazione e non a una specifica persona
- List<Organizzazione> assegnatariPerConoscenzaList - Lista degli assegnatari per conoscenza
-
Returns:
- String -
-
Throws:
- OggettoDocumentoVuoto
- CodiceFascicoloNonEsistente
- AssegnatarioCompetenzaMancante
- TipoProtocolloNonValido
- DestinatarioCompetenzaMancante
- MittenteNonValido
- TipoSpedizioneNonEsistente
- EProcsResponseError
- DataProtocollazioneNonValida
- RegistroNonEsistente
- CodiceTitolarioNonEsistente
- CodiceTitolarioObbligatorio
- NumeroProtocolloNonEsistente
- MittenteDestinatarioIncompleto
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
modificaProtocollo
-
public void modificaProtocollo()
-
Permette di modificare alcuni valori di un Protocollo gia' inserito
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- Protocollo protocollo - Protocollo da modificare
- Integer anno - Anno del Protocollo
- List<String> codiceFascicoli - Codici dei Fascicoli al quale associare il Protocollo: se gia' associato ad un fascicolo, viene aggiunta la nuova associazione
- List<Organizzazione> assegnatariPerCompetenzaList - Lista degli assegnatari per competenza: i documenti protocollati vengono assegnati ad una organizzazione e non a una specifica persona
- List<Organizzazione> assegnatariPerConoscenzaList - Lista degli assegnatari per conoscenza
-
Returns:
- Nothing
-
Throws:
- NumeroProtocolloNonEsistente
- CodiceFascicoloNonEsistente
- TipoProtocolloNonValido
- TipoSpedizioneNonEsistente
- EProcsResponseError
- CodiceTitolarioNonEsistente
- RegistroNonEsistente
- AssegnatarioCompetenzaMancante
- DestinatarioCompetenzaMancante
- MittenteNonValido
- DataProtocollazioneNonValida
- MittenteDestinatarioIncompleto
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
annullaProtocollo
-
public void annullaProtocollo()
-
Permette di annullare un Protocollo gia' inserito
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String numeroProtocollo - Numero di Protocollo del Protocollo da annullare
- Integer anno - Anno del Protocollo
- String numeroProtocolloAutorizzazione - Numero di Protocollo del provvedimento che autorizza l'annullamento
- Integer annoProtocolloAutorizzazione - Anno del Protocollo di Autorizzazione
-
Returns:
- Nothing
-
Throws:
- NumeroProtocolloNonEsistente
- EProcsResponseError
- RegistroNonEsistente
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
dettaglioProtocollo
-
public Protocollo dettaglioProtocollo()
-
Ricupera le informazioni di dettagli riguardanti un Protocollo
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String numeroProtocollo - Numero di Protocollo da ricuperare
- Integer anno - Anno del Protocollo da ricuperare
-
Returns:
- Protocollo -
-
Throws:
- NumeroProtocolloNonEsistente
- EProcsResponseError
- RegistroNonEsistente
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
listaFascicoli
-
public List<Fascicolo> listaFascicoli()
-
Produce la lista dei fascicoli che soddisfano le condizioni specificate
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String codiceTitolario - Codice del Titolario al quale associare il Protocollo
- String codiceFascicolo - Codice del fascicolo da cercare (anche parziale)
- String codiceInterno - Codice interno del fascicolo: non obbligatorio
- String descFascicolo - Descrizione del fascicolo da cercare (anche parziale)
- IntervalloData intervalloDataApertura - Intervallo in cui deve essere compresa la data di apertura del Fascicolo
-
Returns:
- List<Fascicolo> -
-
Throws:
- EProcsResponseError
- RegistroNonEsistente
- CodiceFascicoloNonCompatibile
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
listaProtocolli
-
public List<Protocollo> listaProtocolli()
-
Produce la lista di tutti i Protocolli che corrsispondono alle condizioni specificate
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String numeroProtocollo - Il numero di Protocollo (anche parziale)
- String codiceTitolario - Codice del Titolario al quale associare il Protocollo
- String sottoclasse - Sottoclasse per il codice del Fascicolo: da considerare testo libero
- String codiceFascicolo - Codice del fascicolo a cui il Protocollo e' associato
- String oggetto - Oggetto del Protocollo (puo' essere specificata la prima parte dell'oggetto)
- MittenteDestinatario mittenteDestinatario - Mittente o Destinatario (puo' essere compilato anche solo parzialmente)
- IntervalloData intervalloDataProtocollazione - Intervallo in cui deve essere compresa la data di protocollazione
-
Returns:
- List<Protocollo> -
-
Throws:
- EProcsResponseError
- RegistroNonEsistente
- CodiceFascicoloNonCompatibile
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
listaTitolari
-
public List<Titolario> listaTitolari()
-
Produce la lista di tutti i titolari
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
-
Returns:
- List<Titolario> -
-
Throws:
- RegistroNonEsistente
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
listaTipoSpedizione
-
public List<TipoSpedizione> listaTipoSpedizione()
-
Produce una lista di tutti i tipi di spedizione accettati
-
Parameters:
- Nothing
-
Returns:
- List<TipoSpedizione> -
-
Throws:
- Nothing
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
listaOrganizzazioni
-
public List<Organizzazione> listaOrganizzazioni()
-
Produce una lista di tutte le Organizzazioni
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
-
Returns:
- List<Organizzazione> -
-
Throws:
- RegistroNonEsistente
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
dettagliOrganizzazione
-
public Organizzazione dettagliOrganizzazione()
-
Fornisce i dettagli di una Organizzazione in base al suo codice
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String codice - Codice della Organizzazione
-
Returns:
- Organizzazione -
-
Throws:
- CodiceOrganizzazioneNonEsistente
- RegistroNonEsistente
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
associaDocumentoPrincipaleAProtocollo
-
public void associaDocumentoPrincipaleAProtocollo()
-
Associa il Documento elettronico principale ad un numero di Protocollo gia' creato
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String numeroProtocollo - Numero di Protocollo a cui associare il documento
- Integer anno - Anno del Protocollo
- Documento documento - Documento da inserire
-
Returns:
- Nothing
-
Throws:
- NumeroProtocolloNonEsistente
- FormatoDocumentoInvalido
- RegistroNonEsistente
- EProcsResponseError
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
downloadDocumentoPrincipale
-
public Documento downloadDocumentoPrincipale()
-
Download di un documento in formato elettronico registrato nel sistema documentale
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String numeroProtocollo - Numero di Protocollo a cui il documento e' associato
- Integer anno - Anno del Protocollo
-
Returns:
- Documento -
-
Throws:
- NumeroProtocolloNonEsistente
- DocumentoNonEsistente
- RegistroNonEsistente
- FormatoDocumentoInvalido
- EProcsResponseError
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
associaDocumentoAllegatoAProtocollo
-
public void associaDocumentoAllegatoAProtocollo()
-
Associa un Documento elettronico ad un numero di Protocollo gia' creato come allegato
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String numeroProtocollo - Numero di Protocollo a cui associare il documento
- Integer anno - Anno del Protocollo
- Documento documento - Documento da inserire
- String commento - commento all'allegato
-
Returns:
- Nothing
-
Throws:
- NumeroProtocolloNonEsistente
- FormatoDocumentoInvalido
- RegistroNonEsistente
- EProcsResponseError
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
downloadDocumentoAllegato
-
public Documento downloadDocumentoAllegato()
-
Download di un documento in formato elettronico registrato nel sistema documentale
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String numeroProtocollo - Numero di Protocollo a cui il documento e' associato
- Integer anno - Anno del Protocollo
- String codiceAllegato - Codice dell'allegato chiamato in eprocs come versionId)
-
Returns:
- Documento -
-
Throws:
- NumeroProtocolloNonEsistente
- DocumentoNonEsistente
- RegistroNonEsistente
- FormatoDocumentoInvalido
- EProcsResponseError
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
rimuoviDocumentoAllegatoDaProtocollo
-
public void rimuoviDocumentoAllegatoDaProtocollo()
-
Rimuove un Documento elettronico allegato ad un numero di Protocollo
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String numeroProtocollo - Numero di Protocollo a cui associare il documento
- Integer anno - Anno del Protocollo
- String codiceAllegato - Codice del documento allegato da rimuovere
-
Returns:
- Nothing
-
Throws:
- NumeroProtocolloNonEsistente
- RegistroNonEsistente
- EProcsResponseError
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
listaAllegati
-
public List<Allegato> listaAllegati()
-
lista degli allegati associati ad un protocollo
-
Parameters:
- String registro - registro di protocollo su cui eseguire l'operazione: se null viene usato il registro di default (PROV_BZ)
- String numeroProtocollo - Numero di Protocollo di cui si vuole la lista di allegati
- Integer anno - Anno del Protocollo
-
Returns:
- List<Allegato> -
-
Throws:
- NumeroProtocolloNonEsistente
- RegistroNonEsistente
- EProcsResponseError
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|