AuditSvc.java

/* Index ECM Engine - A system for managing the capture (when created 
 * or received), classification (cataloguing), storage, retrieval, 
 * revision, sharing, reuse and disposition of documents.
 *
 * Copyright (C) 2008 Regione Piemonte
 * Copyright (C) 2008 Provincia di Torino
 * Copyright (C) 2008 Comune di Torino
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2,
 * or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */
 
package it.doqui.index.ecmengine.business.foundation.audit;

import it.doqui.index.ecmengine.dto.engine.audit.AuditSearchParams;
import it.doqui.index.ecmengine.dto.engine.audit.OperazioneAudit;
import it.doqui.index.ecmengine.exception.repository.AuditRuntimeException;

import javax.ejb.EJBLocalObject;

/**
 * Interfaccia pubblica del servizio di gestione degli audit
 * esportata come componente EJB 2.1.
 * 
 * <p>L'implementazione dei metodi qui dichiarati è
 * contenuta nella classe {@link AuditSvcBean}.</p>
 * 
 * <p>Tutti i metodi esportati dal bean di gestione degli audit rimappano le 
 * {@code RuntimeException} ricevute in 
 * {@link it.doqui.index.ecmengine.exception.repository.AuditRuntimeException}.
 * </p>
 * 
 * @author DoQui
 * 
 * @see AuditSvcBean
 * @see it.doqui.index.ecmengine.exception.repository.AuditRuntimeException
 */
public interface AuditSvc extends EJBLocalObject {

	/**
	 * Inserisce nel log dell'audit l'operazione specificata.
	 * 
	 * @param operazioneDto Un oggetto {@link OperazioneAudit} che contiene le informazioni
	 * da inserire nel log dell'audit.
	 */
	public void insertAudit(OperazioneAudit operazioneDto) throws AuditRuntimeException;

	/**
	 * Restituisce tutte le entry nella tabella di audit che soddisfano i parametri
	 * specificati e contenute nell'intervallo di tempo specificato.
	 * 
	 * @param parametriRicerca Parametri in base a cui viene effettuata la ricerca
	 * nella tabella di audit.
	 * 
	 * @return Una lista di {@link OperazioneAudit}.
	 */
	public OperazioneAudit[] ricercaAudit(AuditSearchParams parametriRicerca) throws AuditRuntimeException;

}