blob: 2c5fb556bc07a068c67eb68cec5daf9cd36893e2 [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.tuscany.sca.work;
/**
* Defines the contract for scheduling asynchronous units of work.
*
* <p>
* Units of work can be scheduled with an optional <code>NotificationListener</code>.
* If a notification listener is specified, the caller will be notified regarding the
* status of the work. The unit of work can either be completed, rejected or completed
* with an error. If the work completed with an error, the caller is notified with the
* error details.
* </p>
*
* @version $Rev$ $Date$
* @tuscany.spi.extension.asclient
*/
public interface WorkScheduler {
/**
* Schedules a unit of work for future execution. The notification listener
* is used to register interest in callbacks regarding the status of the work.
*
* @param work The unit of work that needs to be asynchronously executed.
* @param listener Notification listener for callbacks.
*/
<T extends Runnable>void scheduleWork(T work, NotificationListener<T> listener);
/**
* Schedules a unit of work for future execution. The notification listener
* is used to register interest in callbacks regarding the status of the work.
*
* @param work The unit of work that needs to be asynchronously executed.
*/
<T extends Runnable>void scheduleWork(T work);
}