View Javadoc

1   /* This file is part of COPAL (COntext Provisioning for All).
2    *
3    * COPAL is a part of SM4All (Smart hoMes for All) project.
4    *
5    * COPAL is free software: you can redistribute it and/or modify
6    * it under the terms of the GNU Lesser General Public License as published by
7    * the Free Software Foundation, either version 3 of the License, or
8    * (at your option) any later version.
9    *
10   * COPAL is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   * GNU Lesser General Public License for more details.
14   *
15   * You should have received a copy of the GNU Lesser General Public License
16   * along with COPAL. If not, see <http://www.gnu.org/licenses/>.
17   */
18  package at.ac.tuwien.infosys.sm4all.copal.api.service;
19  
20  import at.ac.tuwien.infosys.sm4all.copal.api.event.ContextEvent;
21  import at.ac.tuwien.infosys.sm4all.copal.api.event.ContextEventType;
22  
23  /**
24   * Interface which COPAL core provides to retrieve current context state i.e.
25   * latest published events.
26   * 
27   * @author sanjin
28   */
29  public interface ContextState {
30  
31      /**
32       * Returns all current {@link ContextEvent}s.
33       * 
34       * @return all current {@link ContextEvent}s.
35       */
36      ContextEvent[] getCurrentEvents();
37  
38      /**
39       * Returns current {@link ContextEvent} that has type equal to specified
40       * event name.
41       * 
42       * @param eventName the name of the {@link ContextEventType}.
43       * @return current {@link ContextEvent} that has type name equal to
44       *         specified <code>eventName</code> or <code>null</code> if such
45       *         {@link ContextEvent}s was never published.
46       */
47      ContextEvent getCurrentEvent(String eventName);
48  }