src/main/java/com/capitati/omtc/core/notification/IResourceTaskObserver.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

/*
 * Copyright Capita Translation and Interpreting 2013
 *
 * This file is part of OMTC.
 *
 * OMTC is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * OMTC 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with OMTC.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.capitati.omtc.core.notification;

import com.capitati.omtc.core.resources.IResource;
import com.capitati.omtc.core.session.ISession;

/**
 * A generic resource task observer. On successful completion of a task the
 * onSuccess() method shall be called. Whereas, on an error the onError()
 * method shall be called. The onError() method provides an object, of type F,
 * shall be provided which is the object that was used to invoke the task.
 *
 * @author ianjohnson
 */
public interface IResourceTaskObserver {
  /**
   * Called on successful completion of a resource task.
   * 
   * @param notification
   * @param resource
   * @param invokingSession
   */
  void onSuccess(
      ISession invokingSession,
      IResource resource);

  /**
   * Called when a resource task has failed.
   * 
   * @param notification
   * @param invokingSession
   * @param exception
   */
  void onError(
      ISession session,
      IResource resource,
      Exception exception);
}