com.canoo.dolphin.server.event.TaskExecutor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dolphin-platform-server Show documentation

The Dolphin Platform is a framework that implements the presentation model pattern and provides amodern way to create enterprise applications. The Platform provides several client implementations that all canbe used in combination with a general sever API.

There is a newer version: 1.0.0.CR5

Show newest version

/*
 * Copyright 2015 Canoo Engineering AG.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.canoo.dolphin.server.event;

import java.io.Serializable;

/**
 * 
 * The task executor can be used to trigger specific dolphin controllers (see {@link com.canoo.dolphin.server.DolphinController}).
 * This API is defined in addition to the event bus (see {@link com.canoo.dolphin.server.event.DolphinEventBus}) to handle
 * the usage of reuseable and external components.
 *
 * 
 * Example:
 * Let's say we have create a reuseable MVC group to show notifications. This MVG group should be reused in several projects.
 * In this case using the event bus don't make much sense since if the MVC group is an external / private module we
 * maybe don't know what is the event topic that is used by the MVC widget. In addition if we have several of these widgets
 * we don't know if 2 of them use the same topic. Therefore it's better to interact directly with the MVC widget. To do so
 * can use the {@see TaskExecutor} and simply call public methods of the widget controller.
 * 

 * 

 *
 *
 * The {@see TaskExecutor} provides the possibility to call methods for all given controller instances of the given type
 * in the current session or on the whole server. This can be used to create team application in that the same data can
 * easily be shared and edited between several clients in realtime.
 *
 */
public interface TaskExecutor extends Serializable {

    public  void execute(Class controllerClass, ControllerTask task);

    public  void executeForSession(Class controllerClass, ControllerTask task);

}