Interface IMagicCycle


  • public interface IMagicCycle
    Represents a cycle (or category) grouping for magics. A magic cycle holds ordering and display information as well as associations to multiple magics.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDisplayName()
      Gets the display name of the magic cycle.
      int getId()
      Gets the unique identifier of this magic cycle.
      int getLayoutType()
      Gets the layout type for the cycle.
      java.lang.String getName()
      Gets the internal name of the magic cycle.
      void setDisplayName​(java.lang.String displayName)
      Sets the display name of the magic cycle.
      void setLayoutType​(int layout)
      Sets the layout type for the cycle.
      void setName​(java.lang.String name)
      Sets the internal name of the magic cycle.
    • Method Detail

      • getId

        int getId()
        Gets the unique identifier of this magic cycle.
        Returns:
        the cycle ID
      • getName

        java.lang.String getName()
        Gets the internal name of the magic cycle.
        Returns:
        the name of the cycle
      • setName

        void setName​(java.lang.String name)
        Sets the internal name of the magic cycle.
        Parameters:
        name - the new name of the cycle
      • getDisplayName

        java.lang.String getDisplayName()
        Gets the display name of the magic cycle.
        Returns:
        the display name for the cycle
      • setDisplayName

        void setDisplayName​(java.lang.String displayName)
        Sets the display name of the magic cycle.
        Parameters:
        displayName - the new display name of the cycle
      • getLayoutType

        int getLayoutType()
        Gets the layout type for the cycle. This is typically an integer representation of the layout enum. 0: CIRCULAR 1: SQUARE 2: TREE 3: GENERATED 4: CIRCULAR_MANUAL 5: SQUARE_MANUAL 6: TREE_MANUAL 7: CHART
        Returns:
        the layout type as an integer
      • setLayoutType

        void setLayoutType​(int layout)
        Sets the layout type for the cycle. The provided integer should correspond to a valid layout type. 0: CIRCULAR 1: SQUARE 2: TREE 3: GENERATED 4: CIRCULAR_MANUAL 5: SQUARE_MANUAL 6: TREE_MANUAL 7: CHART
        Parameters:
        layout - the layout type as an integer