org.daisy.pipeline.client.models.script
Class Argument

java.lang.Object
  extended by org.daisy.pipeline.client.models.script.Argument
Direct Known Subclasses:
ArgBoolean, ArgFile, ArgFiles, ArgParameters, ArgString, ArgStrings

public class Argument
extends java.lang.Object

A script argument.


Field Summary
 java.lang.String desc
          A description of the option.
 boolean hide
          For use when rendering the job creation form
 java.lang.String kind
          Type of underlying argument.
 java.util.List<java.lang.String> mediaTypeBlacklist
          Only relevant for file arguments.
 java.util.List<java.lang.String> mediaTypes
          MIME types accepted (only relevant if type=anyDirURI or anyFileURI)
 java.lang.String name
          The name of the argument.
 java.lang.String nicename
          This is the value from the px:role="name" in the script documentation.
 boolean ordered
          whether or not the ordering matters (only relevant if sequence==true)
 java.lang.String output
          Arguments with a output value of "result" or "temp" will only be included when the framework is running in local mode.
 boolean required
          whether or not this argument is required
 boolean sequence
          whether or not multiple selections can be made
 java.lang.String xsdType
          XSD type
 
Constructor Summary
Argument()
           
Argument(Argument arg)
           
 
Method Summary
 org.w3c.dom.Node asDocumentElement(org.w3c.dom.Document document)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

public java.lang.String name
The name of the argument. This isn't necessarily unique; since inputs and options can have the same name.


nicename

public java.lang.String nicename
This is the value from the px:role="name" in the script documentation.


desc

public java.lang.String desc
A description of the option.


required

public boolean required
whether or not this argument is required


sequence

public boolean sequence
whether or not multiple selections can be made


ordered

public boolean ordered
whether or not the ordering matters (only relevant if sequence==true)


mediaTypes

public java.util.List<java.lang.String> mediaTypes
MIME types accepted (only relevant if type=anyDirURI or anyFileURI)


xsdType

public java.lang.String xsdType
XSD type


output

public java.lang.String output
Arguments with a output value of "result" or "temp" will only be included when the framework is running in local mode.


kind

public java.lang.String kind
Type of underlying argument. Either "input", "parameters", "option" or "output".


mediaTypeBlacklist

public java.util.List<java.lang.String> mediaTypeBlacklist
Only relevant for file arguments. If mediaTypeBlacklist is defined, then all XML files are supported for this argument, except those listed in this list.


hide

public boolean hide
For use when rendering the job creation form

Constructor Detail

Argument

public Argument()

Argument

public Argument(Argument arg)
Method Detail

asDocumentElement

public org.w3c.dom.Node asDocumentElement(org.w3c.dom.Document document)