/*
 * Version 1.1
 * CeCILL Copyright (c) 2006-2007, AtolCD, ADULLACT-projet
 * Initiated by AtolCD S.A. & ADULLACT-projet S.A.
 * Developped by AtolCD
 * 
 * contact@atolcd.com
 * contact@adullact-projet.coop
 * 
 * Ce logiciel est un programme informatique servant à faire circuler des 
 * documents au travers d'un circuit de validation, où chaque acteur vise 
 * le dossier, jusqu'à l'étape finale de signature.
 * 
 * Ce logiciel est régi par la licence CeCILL soumise au droit français et
 * respectant les principes de diffusion des logiciels libres. Vous pouvez
 * utiliser, modifier et/ou redistribuer ce programme sous les conditions
 * de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA 
 * sur le site "http://www.cecill.info".
 * 
 * En contrepartie de l'accessibilité au code source et des droits de copie,
 * de modification et de redistribution accordés par cette licence, il n'est
 * offert aux utilisateurs qu'une garantie limitée.  Pour les mêmes raisons,
 * seule une responsabilité restreinte pèse sur l'auteur du programme,  le
 * titulaire des droits patrimoniaux et les concédants successifs.
 * 
 * A cet égard  l'attention de l'utilisateur est attirée sur les risques
 * associés au chargement,  à l'utilisation,  à la modification et/ou au
 * développement et à la reproduction du logiciel par l'utilisateur étant 
 * donné sa spécificité de logiciel libre, qui peut le rendre complexe à 
 * manipuler et qui le réserve donc à des développeurs et des professionnels
 * avertis possédant  des  connaissances  informatiques approfondies.  Les
 * utilisateurs sont donc invités à charger  et  tester  l'adéquation  du
 * logiciel à leurs besoins dans des conditions permettant d'assurer la
 * sécurité de leurs systèmes et ou de leurs données et, plus généralement, 
 * à l'utiliser et l'exploiter dans les mêmes conditions de sécurité. 
 * 
 * Le fait que vous puissiez accéder à cet en-tête signifie que vous avez 
 * pris connaissance de la licence CeCILL, et que vous en avez accepté les
 * termes.
 *  
 */

package com.atolcd.parapheur.repo;

import java.io.IOException;
import java.util.Map;
import java.util.Properties;

import org.alfresco.service.cmr.repository.NodeRef;

public interface S2lowService
{
   /**
    * Retourne la disponibilité du service
    * 
    * @return true si la configuration demande l'utilisation du S2lowService
    */
   public boolean isEnabled();
   
   /**
    * Retourne les propriétés nécessaires à la signature XAdES
    * 
    * @return un objet Properties
    */
   public Properties getXadesSignatureProperties();
   
   /**
    * Retourne la liste des natures d'actes de s2low
    * 
    * @return une map contenant les couples clé/valeur des natures d'actes
    */
   public Map<Integer, String> getS2lowActesNatures();
   
   /**
    * Retourne la liste des classifications d'actes de s2low
    * 
    * @return une map contenant les couples clé/valeur des classifications d'actes
    */
   public Map<String, String> getS2lowActesClassifications();
   
   /**
    * Transmet le dossier passé en paramètre à la plate-forme S2Low-ACTES et retourne le numéro de transaction créé
    * 
    * @param dossier
    * @param nature
    * @param classification
    * @param numero
    * @param objet
    * @param date
    * @throws IOException si une erreur survient durant la connexion à la plate-forme
    */
   public void envoiS2lowActes(NodeRef dossier, String nature, String classification, String numero, String objet, String date) throws IOException;

   /**
    * Transmet le dossier passé en paramètre à la plate-forme S2Low et retourne le numéro de transaction créé
    * 
    * @param dossier
    * @return l'URL d'archive
    * @throws IOException si une erreur survient durant la connexion à la plate-forme
    */
   public String setS2lowActesArchiveURL(NodeRef dossier) throws IOException;
   
   /**
    * Demande le statut du dossier passé en paramètre à la plate-forme S2LOW
    * 
    * @param dossier le dossier à vérifier
    * @return le code retour de la plate-forme S2LOW, à convertir avec statutS2lowToString
    * @throws IllegalArgumentException si <code>dossier</code> ne représente pas un dossier, st null ou n'a pas été envoyé à la plate-forme S2LOW
    * @throws IOException si une erreur survient durant la connexion à la plate-forme
    */
   public int getInfosS2low(NodeRef dossier) throws IOException;
   
   /**
    * Convertit le code retour de Statut S2LOW en chaine de caractères explicite
    * @param code le statut numerique à convertir
    * @return une chaîne de caractères contenant la réponse de la plate-forme S2LOW au format texte intelligible
    */
   public String statutS2lowToString(int code);
   
   /**
    * Retourne la référence du noeud contenant les classifications S2low pour MAJ
    *  
    * @return un NodeRef correspondant au fichier XML des classifications S2low
    */
   public NodeRef getS2lowActesClassificationNodeRef();

   /**
    * Transmet le dossier passé en paramètre à la plate-forme S2Low-HELIOS et retourne le numéro de transaction créé
    * 
    * @param dossier
    * @throws IOException si une erreur survient durant la connexion à la plate-forme
    */
   public void envoiS2lowHelios(NodeRef dossier) throws IOException;

   /**
    * Récupère la liste des PES_RETOUR
    * 
    * @throws IOException si une erreur survient durant la connexion à la plate-forme
    */
   public void getS2lowHeliosListePES_Retour() throws IOException;

}