Package com.sodius.mdw.server.services

Interface Service

  • All Superinterfaces:
    NamedElement
    public interface Service
extends NamedElement
    Describes a service that can be executed within the context of MDWorkbench Server. A service is contributed using the com.sodius.mdw.server.service extension point. A service execution involves evaluating either an underlying ruleset or an Operation.

    This interface is not intended to be implemented by clients.

    See Also:
    ServicesManager.getServices()

    • Method Detail

      • getDescription

        String getDescription()
        Returns the description of this service.
        Returns:
        the description of this service.

      • getKind

        ServiceKind getKind()
        Returns the implementation type of the service.
        Returns:
        the implementation type of the service.
        Since:
        2.3.0

      • getRuleSetName

        @Deprecated
String getRuleSetName()
        Deprecated.
        Services can be implemented with an Operation since 2.3.0, in which case this method returns null.
        Returns the ruleset qualified name evaluated when the service is to execute. The underlying ruleset must be defined in the plug-in that contributes this service.
        Returns:
        the ruleset qualified name, null if the service is implemented with an Operation.
        See Also:
        getKind()

      • getRuleName

        @Deprecated
String getRuleName()
        Deprecated.
        Services can be implemented with an Operation since 2.3.0, in which case this method returns null.
        Returns the name of the rule evaluated when the service is to execute. The rule must be defined in the ruleset referenced in this service.
        Returns:
        the name of the rule, null if the service is implemented with an Operation.
        See Also:
        getKind()

      • getParameters

        List<Parameter> getParameters()
        Returns the list of parameters expected by this service to execute the underlying ruleset.
        Returns:
        the list of parameters expected by this service.