Package jadex.bridge.service.types.cms

Interface IComponentDescription

  • All Known Implementing Classes:
    CMSComponentDescription
    public interface IComponentDescription
    A description of a component, i.e. information about the execution state, component type, etc.

    • Field Detail

      • STATE_ACTIVE

        static final java.lang.String STATE_ACTIVE
        Predefined value "active" for slot state.
        See Also:
        Constant Field Values

      • STATE_SUSPENDED

        static final java.lang.String STATE_SUSPENDED
        Predefined value "suspended" for slot state.
        See Also:
        Constant Field Values

      • STATE_TERMINATED

        static final java.lang.String STATE_TERMINATED
        Predefined value "terminated" for slot state.
        See Also:
        Constant Field Values

    • Method Detail

      • getName

        IComponentIdentifier getName()
        Get the identifier of the component.
        Returns:
        The component identifier.

      • getModelName

        java.lang.String getModelName()
        Get the model name.
        Returns:
        The model name.

      • getFilename

        java.lang.String getFilename()
        Get the file name.
        Returns:
        The file name.

      • getResourceIdentifier

        IResourceIdentifier getResourceIdentifier()
        Get the resource identifier.
        Returns:
        The resource identifier.

      • getOwnership

        java.lang.String getOwnership()
        Get the ownership string of the component.
        Returns:
        The ownership string.

      • getType

        java.lang.String getType()
        Get the component type.
        Returns:
        The component type name (e.g. 'BDI Agent').

      • getState

        java.lang.String getState()
        Get the execution state of the component. E.g. active or suspended.
        Returns:
        The state.

      • getCreationTime

        long getCreationTime()
        Get the creation time.
        Returns:
        The creation time.

      • getCreator

        IComponentIdentifier getCreator()
        Get the creator of this component. (parent in case of child or external in case of top-level component).

      • getBreakpoints

        java.lang.String[] getBreakpoints()
        Get the enabled breakpoints (if any).
        Returns:
        The enabled breakpoints.

      • isSynchronous

        boolean isSynchronous()
        Get the synchronous flag.
        Returns:
        The synchronous flag.

      • getLocalType

        java.lang.String getLocalType()
        Get the local type name of a component (defined in the parent).
        Returns:
        The local type.

      • isSystemComponent

        boolean isSystemComponent()
        Test if it is a system component.
        Returns:
        True, if it is a system component.