Package com.iizix.ws.prop.url

Class URLInputParameter

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.prop.vs.AbstractVSVariable<VSField,VSFieldReference>
com.iizix.ws.prop.url.URLInputParameter
All Implemented Interfaces:
EventListener, IGProp<GProp<?>[]>, IPropCnr, Cloneable
Direct Known Subclasses:
EditorURLInputParameter
public class URLInputParameter extends AbstractVSVariable<VSField,VSFieldReference>
The Input Variable connects a VSField with an input variable or parameter to a web service request.
Author:
Christopher Mindus

  • Field Details

    • PN_URI_PATH

      public static final String PN_URI_PATH
      The property name for option to use parameter in URI path.
      See Also:

  • Constructor Details

    • URLInputParameter

      public URLInputParameter()
      Creates an input variable property container with the specified name with a null value.

    • URLInputParameter

      public URLInputParameter(Atom propertyAtom)
      Creates an input variable property container with the specified name with a null value.
      Parameters:
      propertyAtom - the property atom.

  • Method Details

    • clone

      public URLInputParameter clone()
      Clones this variable instance.
      Overrides:
      clone in class AbstractVSVariable<VSField,VSFieldReference>

    • getVSPropertyClass

      public Class<VSField> getVSPropertyClass()
      Gets the class wanted for the VS component being referenced.
      Specified by:
      getVSPropertyClass in class AbstractVSVariable<VSField,VSFieldReference>
      Returns:
      VSField.class, VSColumnHeader.class or VSTable.class.

    • getVSReferenceClass

      public Class<VSFieldReference> getVSReferenceClass()
      Gets the class wanted for VS references.
      Specified by:
      getVSReferenceClass in class AbstractVSVariable<VSField,VSFieldReference>
      Returns:
      VSFieldReference.class.

    • getVSField

      public VSField getVSField(IAppSessionGyro appGyro)
      Gets the VSField.
      Parameters:
      appGyro - The application session gyro, null in the Designer.
      Returns:
      The VSField associated, or null for none (or unresolved).

    • getDescription

      public String getDescription()
      Gets the field description.
      Returns:
      A description, or null for none.

    • getValue

      public Value getValue(IAppSessionGyro appGyro)
      Gets the current value. If there is a connection to a VS Field, the value is taken from there.
      Parameters:
      appGyro - The application session gyro, null in the Designer.
      Returns:
      The value for the variable, or null if not yet defined.

    • getNullReplacement

      public String getNullReplacement()
      Null replacement value.
      Returns:
      The string to use when replacing a null value, null to omit.

    • isURIPathParameter

      public boolean isURIPathParameter()
      Returns whether this parameter should be used in the query part (default) or to build the URI path. The latter case requires the request option "Parameterized path URI".