Class MoveToEpisodeException

All Implemented Interfaces:
Serializable

public class MoveToEpisodeException extends SpecialException
Control-flow exception that requests navigation to a named or numbered Act episode.

Embedding processors interpret this exception as an intentional workflow transition rather than an application error. The target may be identified by its one-based numeric identifier, its name, or neither to request the next episode.

Author:
Viktor Tovstyi
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serialization version for compatibility when this control-flow exception is serialized.
      See Also:
    • episodeId

      private final Integer episodeId
      Optional one-based identifier of the requested target episode.

      A null value indicates that navigation is not targeted by a numeric identifier.

    • episodeName

      private final String episodeName
      Optional name of the requested target episode.

      A null value indicates that navigation is not targeted by a name.

  • Constructor Details

    • MoveToEpisodeException

      public MoveToEpisodeException(Integer episodeId, String name)
      Creates a navigation request for an episode identifier or name.

      If episodeId is null, the exception message describes a request to move to the next episode; otherwise, it identifies the supplied numeric target. The episode name is retained independently and may be used by the receiving workflow processor.

      Parameters:
      episodeId - target one-based episode identifier, or null
      name - target episode name, or null when navigation is not targeted by name
  • Method Details

    • getEpisodeId

      public Integer getEpisodeId()
      Returns the requested target episode identifier.
      Returns:
      the one-based episode identifier, or null when the target was not specified by identifier
    • getName

      public String getName()
      Returns the requested target episode name.
      Returns:
      the target episode name, or null when the target was not specified by name