Package com.swiftmq.swiftlet.scheduler

Class JobParameter

  • public class JobParameter
extends java.lang.Object
    A JobParameter object contains meta data about Job parameters. It is used from the Scheduler Swiftlet to verify user-specified parameter values before a Job is started.
    Author:
    IIT GmbH, Bremen/Germany, Copyright (c) 2000-2003, All Rights Reserved

    • Constructor Summary

      Constructors 
      Constructor Description
      JobParameter​(java.lang.String name, java.lang.String description, java.lang.String defaultValue, boolean mandatory, JobParameterVerifier verifier)
      Creates a new JobParameter object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDefaultValue()
      Returns the default value (null if no default is specified).
      java.lang.String getDescription()
      Returns the description.
      java.lang.String getName()
      Returns the name.
      JobParameterVerifier getVerifier()
      Returns the optional verifier.
      boolean isMandatory()
      Returns whether this parameter is optional or mandatory.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • JobParameter

        public JobParameter​(java.lang.String name,
                    java.lang.String description,
                    java.lang.String defaultValue,
                    boolean mandatory,
                    JobParameterVerifier verifier)
        Creates a new JobParameter object.
        Parameters:
        name - Name
        description - Short Description
        defaultValue - optional default value
        mandatory - whether it is mandatory or optional
        verifier - optional verifier

    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the name.
        Returns:
        Name

      • getDescription

        public java.lang.String getDescription()
        Returns the description.
        Returns:
        description

      • getDefaultValue

        public java.lang.String getDefaultValue()
        Returns the default value (null if no default is specified).
        Returns:
        default value

      • isMandatory

        public boolean isMandatory()
        Returns whether this parameter is optional or mandatory.
        Returns:
        true / false

      • getVerifier

        public JobParameterVerifier getVerifier()
        Returns the optional verifier.
        Returns:
        verifier

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object