com.vii.brillien.kernel.axiom.component.State Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of clearity Show documentation
The newest version!
/*
 * Copyright (c) 2012 Imre Fazekas.
 *  All rights reserved.
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  Redistributions of source code must retain the above copyright notice, this
 *  list of conditions and the following disclaimer.
 *
 *  Redistributions in binary form must reproduce the above copyright notice,
 *  this list of conditions and the following disclaimer in the documentation
 *  and/or other materials provided with the distribution.
 *  Neither the name of the Brillien nor the names of its
 *  terms and concepts may be used to endorse or promote products derived from this
 *  software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

package com.vii.brillien.kernel.axiom.component;

/**
 * State interface defined the basic behavior of a state object describing state information in a Presence object.
 * It is handled by the StateDivision objects to decide whether a State transition is correct or not. 
 */
public interface State {

    /**
     * Tells whether the role of the State is init or not
     */
    boolean         isInit();

    /**
     * Tells whether the role of the State is exit or not
     */
    boolean         isExit();

    /**
     * Tells whether the role of the State is error or not
     */
    boolean         isError();

    /**
     * Tells whether the State is active in the current Presence object
     * @return boolean value of the report about its activity
     */
    boolean         isActive();

    /**
     * Gives the unique name of the State object
     * @return unique name
     */
    String          getName();

    /**
     * Sets the unique name of the State object
     */
    void            setName(String name);

}