001    /*
002     * Copyright 2005 Stephen J. McConnell.
003     *
004     * Licensed  under the  Apache License,  Version 2.0  (the "License");
005     * you may not use  this file  except in  compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     *   http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed  under the  License is distributed on an "AS IS" BASIS,
012     * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
013     * implied.
014     *
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    
019    package net.dpml.state;
020    
021    /**
022     * Interface describing a transition that may be performed under an activate 
023     * state.
024     *
025     * @author <a href="http://www.dpml.net">Digital Product Management Laboratory</a>
026     * @version 2.0.2
027     */
028    public interface Transition extends Action
029    {  
030       /**
031        * Set the state that this transition is a part of.
032        * @param state the owning state
033        */
034        void setState( State state );
035        
036       /**
037        * Return the state that this transition is a part of.
038        * @return the owning state
039        */
040        State getState();
041        
042       /**
043        * Return the transition target state name
044        * @return the target state name
045        */
046        String getTargetName();
047        
048       /**
049        * Return an operation associated with the transition.
050        * @return a possibly null operation
051        */
052        Operation getOperation();
053    }