001/*
002 * Stallion Core: A Modern Web Framework
003 *
004 * Copyright (C) 2015 - 2016 Stallion Software LLC.
005 *
006 * This program is free software: you can redistribute it and/or modify it under the terms of the
007 * GNU General Public License as published by the Free Software Foundation, either version 2 of
008 * the License, or (at your option) any later version. This program is distributed in the hope that
009 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
011 * License for more details. You should have received a copy of the GNU General Public License
012 * along with this program.  If not, see <http://www.gnu.org/licenses/gpl-2.0.html>.
013 *
014 *
015 *
016 */
017
018package io.stallion.asyncTasks;
019
020/**
021 * This implements a handler for async tasks. The data your task needs for
022 * execution should be added as bean properties to your implementing class.
023 * So if you had a CalendarReminderHandler, you might have a property
024 * userId and eventId. Then your "process" method would look up the user,
025 * look up the event, and send the user an email about the event. Since
026 * the entire class will be serialized, you prefer to use ids as properties,
027 * rather than large objects. Store the eventId or userId, not the event or user.
028 *
029 */
030public interface AsyncTaskHandler {
031    /**
032     * Override this to write your custom code for actually executing the task
033     */
034    public void process();
035
036    /**
037     * The internal AsyncTask object associated with this instance.
038     * @return
039     */
040    public AsyncTask getTask();
041    public AsyncTaskHandler setTask(AsyncTask task);
042}