org.kinotic.continuum.grind.api.Task Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of continuum-grind Show documentation

A Microservice and IOT framework for everyone!

There is a newer version: 2.0.0

/*
 *
 * Copyright 2008-2021 Kinotic and the original author or authors.
 *
 * 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
 *
 *      https://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 org.kinotic.continuum.grind.api;

import org.springframework.context.support.GenericApplicationContext;

/**
 * A general definition of a task that can be executed at some point in the future.
 *
 *
 * Created by Navid Mitchell 🤪 on 3/24/20
 */
public interface Task {

    /**
     * @return the description of this {@link Task}
     */
    String getDescription();

    /**
     * This method needs to perform the logic that actually returns the value created by this {@link Task} if any.
     * @param applicationContext the execution context for this job
     * @return the result of this {@link Task}
     *         This can be any value or any of the following which will be handled with special consideration.
     *         Result can be another {@link Task} in this case the {@link Task} will be executed and the result will be handled according to these same rules
     *         Result can be a {@link JobDefinition} in this case the {@link JobDefinition} will be executed and all results will be handled according to these rules
     *         Result can be a {@link Result} object in this case the {@link Result} will be returned along with any other {@link Result}'s during task execution
     *
     */
    T execute(GenericApplicationContext applicationContext) throws Exception;

}