as2lib 0.9

     1  /*
     2   * Copyright the original author or authors.
     3   * 
     4   * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   * 
     8   *      http://www.mozilla.org/MPL/MPL-1.1.html
     9   * 
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  import org.as2lib.app.exec.Batch;
    18  
    19  /**
    20   * {@code BatchUpdateListener} is a defintion for a observer for updates of a
    21   * {@link Batch}.
    22   * 
    23   * <p>To observe changes/updates of a {@code Batch} you can implement this
    24   * interface and add your implementation with {@link Batch#addListener} to
    25   * observe a certain {@code Batch}.
    26   * 
    27   * <p>{@code start}, {@code error} and {@code finish} are no accepted changes of
    28   * the state.
    29   * 
    30   * @author Martin Heidegger
    31   * @version 2.0
    32   * @see Process
    33   */
    34  interface org.as2lib.app.exec.BatchUpdateListener {
    35  	
    36  	/**
    37  	 * Method to be executed if a {@code Batch} property changes.
    38  	 * 
    39  	 * @param batch {@link Batch} that changed some properties
    40  	 */
    41  	public function onBatchUpdate(batch:Batch):Void;	
    42  }