001/*
002 * (C) Copyright 2006-2008 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Alexandre Russel
018 *
019 * $Id$
020 */
021
022package org.nuxeo.ecm.platform.annotations.repository.service;
023
024import org.nuxeo.ecm.core.api.DocumentLocation;
025import org.nuxeo.ecm.core.api.NuxeoPrincipal;
026import org.nuxeo.ecm.platform.annotations.api.Annotation;
027
028/**
029 * @author Alexandre Russel
030 */
031public interface AnnotatedDocumentEventListener {
032
033    String ANNOTATION_CREATED = "annotationCreated";
034
035    String ANNOTATION_UPDATED = "annotationUpdated";
036
037    String ANNOTATION_DELETED = "annotationDeleted";
038
039    String ANNOTATION_ID = "annotationId";
040
041    String ANNOTATION_SUBJECT = "annotationSubject";
042
043    String ANNOTATION_BODY = "annotationBody";
044
045    void beforeAnnotationCreated(NuxeoPrincipal principal, DocumentLocation documentLoc, Annotation annotation);
046
047    void afterAnnotationCreated(NuxeoPrincipal principal, DocumentLocation documentLoc, Annotation annotation);
048
049    void beforeAnnotationRead(NuxeoPrincipal principal, String annotationId);
050
051    void afterAnnotationRead(NuxeoPrincipal principal, DocumentLocation documentLoc, Annotation annotation);
052
053    void beforeAnnotationUpdated(NuxeoPrincipal principal, DocumentLocation documentLoc, Annotation annotation);
054
055    void afterAnnotationUpdated(NuxeoPrincipal principal, DocumentLocation documentLoc, Annotation annotation);
056
057    void beforeAnnotationDeleted(NuxeoPrincipal principal, DocumentLocation documentLoc, Annotation annotation);
058
059    void afterAnnotationDeleted(NuxeoPrincipal principal, DocumentLocation documentLoc, Annotation annotation);
060}