/**
 *  Generated with Tigerstripe(tm) Tigerstripe Workbench Feature 2.2.0.v20070419-1556-GFEkmUll2-0111E.
 *
 *  Tigerstripe(tm) is a registered trademark of Tigerstripe, Inc.
 *
 *  Plugin  : Sun Microsystems Inc./SunJavaSpecificationPlugin(1.0) (1.0)
 *
 *  DO NOT EDIT THIS CODE WAS AUTOMATICALLY GENERATED
 *
 *  Generated from source Tigerstipe Artifact :
 *        javax.oss.cbe.datatypes.StateHandler
 *
 *  Using template :
 *        templates/1.3/datatypeInterface.vm
 *
 * Copyright 2002-2007 The Members of the OSS through Java(TM) Initiative.
 * All rights reserved. Use is subject to license terms.
 */
package javax.oss.cbe.datatypes;

import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import javax.xml.bind.annotation.XmlType;

import ossj.common.cbe.datatypes.StateHandlerAdapter;

@XmlType
@XmlJavaTypeAdapter(value=StateHandlerAdapter.class)

/**
 *  Public interface definition for StateHandler.
 *
 * This interface defines the <CODE>CBE State</CODE>.
 *
 */
public interface StateHandler 
	extends java.lang.Cloneable, java.io.Serializable {

    public static final java.lang.String DATA_TYPE = "State";

    /**
     * Deep copy of this object.
     *
     * @return The cloned object
     */
    public Object clone();


    /**
     *
     * Attribute getter for state.
     *
     *
     * Changes the state value using the given argument
     *
     * @return the value of the state field.
     *
     */
    public java.lang.String getState( );


    /**
     * Attribute setter for state.
     *
     *
     * Changes the state value using the given argument
     * @param value - the value to use to set the state attribute.
     * @throws java.lang.IllegalArgumentException
     *         Thrown to report that a bad argument was provided to the method.
     *
     */
    public void setState(java.lang.String value)
        throws
        java.lang.IllegalArgumentException;

    /**
     *
     * Attribute getter for supportedStates.
     *
     *
     * 
     *
     * @return the value of the supportedStates field.
     *
     */
    public java.lang.String[] getSupportedStates( );




    /**
     * User specified method - trySetState.
     *
     * Returns true if the proposed new given state can be applied.
     * This method <B>do not change</B> the current value of the state,
     * but it is used to verify if the proposed new state is applicable.
     * <p>
     * A returned false means that the state transition from the current value to the given one is not valid.
     *
     *    This method is MANDATORY
     * @return boolean
     * @param state - 
     *
     */
    public boolean trySetState ( 
        java.lang.String state);


    /**
     * User specified method - contains.
     *
     * Returns true if the given state is available in the managed list.
     *
     *    This method is MANDATORY
     * @return boolean
     * @param state - 
     *
     */
    public boolean contains ( 
        java.lang.String state);


}
