Package com.tibco.ep.tcs.runtime.config

Interface IBlockInstance

  • public interface IBlockInstance

    An interface describing a block instance in a flow. Instances can contain inline meta-data or point to a block type via block type ID. Inline meta-data is exclusive with a referenced block type ID.

    • Method Detail

      • getBlockID

        String getBlockID()

        Return this block instance's referenced block identifier; that is, the block of which this object is an instance. This value is null if the block instance uses inline block metadata and non-null if it does not.

        Returns:
        block ID, null if an inline block

      • getLabel

        String getLabel()

        Return the block instance's human-readable label, null if none.

        Returns:
        label, null if none

      • getDescription

        String getDescription()

        Return the block instance's human-readable description, null if none.

        Returns:
        description, null if none

      • getConfiguration

        @Deprecated
String getConfiguration()
        Deprecated.
        use #getInstanceConfig

        Return this block instance's configuration, null if none.

        Returns:
        configuration, null if none

      • getInstanceConfig

        com.typesafe.config.Config getInstanceConfig()

        Return this block instance's configuration, null if none.

        Returns:
        configuration, null if none

      • getInlineBlockMetaData

        IBlockMetaData getInlineBlockMetaData()

        For inline block definitions, return the block metadata that would otherwise appear in the referenced block project, null if none. This value is null if the block instance has a block ID and non-null if it does not. The type of the returned value indicates the kind of block being inlined.

        Returns:
        inline block metadata, null if an identified block