Package com.change_vision.jude.api.inf.model

Interface IState

All Superinterfaces:
IElement, IEntity, IHyperlinkOwner, INamedElement, IVertex
All Known Subinterfaces:
IFinalState
public interface IState extends IVertex
Interface for States.

  • Method Details

    • getSubmachine

      IStateMachine getSubmachine()
      Get Submachine.
      Returns:
      Submachine.

    • isSubmachineState

      boolean isSubmachineState()
      Check if it is a SubmachineState.
      Returns:
      true it is a SubmachineState / false it is not a SubmachineState

    • getEntry

      String getEntry()
      Get Entry.
      Returns:
      Entry.

    • setEntry

      void setEntry(String entry)
      Set Entry.
      Parameters:
      entry - Entry. In the case of null,Entry shall be deleted.
      Throws:
      InvalidEditingException - InvalidEditingException occurs. 
      Keys:
        ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in astah* community.
        PARAMETER_ERROR_KEY - if a parameter is not set properly.
        BAD_TRANSACTION_KEY - Bad Transaction.
        HAS_EXCEPTION_KEY - if an exception has occurred.
        READ_ONLY_KEY - if a read-only element is edited.
      Values:
        Error messages for exceptions.

    • getDoActivity

      String getDoActivity()
      Get DoActivity.
      Returns:
      DoActivity.

    • setDoActivity

      void setDoActivity(String doActivity)
      Set DoActivity.
      Parameters:
      doActivity - DoActivity. In the case of null,DoActivity shall be deleted.
      Throws:
      InvalidEditingException - InvalidEditingException occurs. 
      Keys:
        ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in astah* community.
        PARAMETER_ERROR_KEY - if a parameter is not set properly.
        BAD_TRANSACTION_KEY - Bad Transaction.
        HAS_EXCEPTION_KEY - if an exception has occurred.
        READ_ONLY_KEY - if a read-only element is edited.
      Values:
        Error messages for exceptions.

    • getExit

      String getExit()
      Get Exit.
      Returns:
      Exit.

    • setExit

      void setExit(String exit)
      Set Exit.
      Parameters:
      exit - Exit. In the case of null, Exit shall be deleted.
      Throws:
      InvalidEditingException - InvalidEditingException occurs. 
      Keys:
        ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in astah* community.
        PARAMETER_ERROR_KEY - if a parameter is not set properly.
        BAD_TRANSACTION_KEY - Bad Transaction.
        HAS_EXCEPTION_KEY - if an exception has occurred.
        READ_ONLY_KEY - if a read-only element is edited.
      Values:
        Error messages for exceptions.

    • getInternalTransitions

      ITransition[] getInternalTransitions()
      Get Internal Transitions.
      Returns:

    • addInternalTransition

      void addInternalTransition(String event, String guard, String action)
      Add an Internal Transition.
      Parameters:
      event -
      guard -
      action -
      Throws:
      InvalidEditingException - InvalidEditingException occurs. 
      Keys:
        ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in astah* community.
        PARAMETER_ERROR_KEY - if a parameter is not set properly.
        BAD_TRANSACTION_KEY - Bad Transaction.
        HAS_EXCEPTION_KEY - if an exception has occurred.
        READ_ONLY_KEY - if a read-only element is edited.
      Values:
        Error messages for exceptions.

    • deleteAllInternalTransitions

      void deleteAllInternalTransitions()
      Delete All Internal Transition.
      Throws:
      InvalidEditingException - InvalidEditingException occurs. 
      Keys:
        ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in astah* community.
        BAD_TRANSACTION_KEY - Bad Transaction.
        HAS_EXCEPTION_KEY - if an exception has occurred.
        READ_ONLY_KEY - if a read-only element is edited.
      Values:
        Error messages for exceptions.

    • getSubvertexes

      IVertex[] getSubvertexes()
      Get SubVertexes.
      Returns:
      The array of SubVertexes. Return the empty array if there is none.

    • getRegions

      List<IState> getRegions()
      Get child States in all Regions.
      Returns:
      List of child States contained in all Regions. Returns an empty list if there are none.
      Since:
      11.0

    • getRegionSize

      int getRegionSize()
      Get Region Size.
      Returns:
      The size of region.

    • getRegionRectangle

      Rectangle2D getRegionRectangle(int regionIndex)
      Get the Rectangle of Specified Region.
      Parameters:
      regionIndex -
      Returns:
      Rectangle
      Throws:
      InvalidUsingException - InvalidUsingException occurs. 
      Keys:
        ILLEGAL_USE_ERROR_KEY - if regionIndex is out of range.
      Values:
        Error messages for exceptions.

    • getSubvertexes

      IVertex[] getSubvertexes(int regionIndex)
      Get SubVertexes of Specified Region.
      Parameters:
      regionIndex -
      Returns:
      The array of SubVertexes. Return the empty array if there is none.
      Throws:
      InvalidUsingException - InvalidUsingException occurs. 
      Keys:
        ILLEGAL_USE_ERROR_KEY - if regionIndex is out of range.
      Values:
        Error messages for exceptions.