org.daisy.pipeline.client.models
Class Script

java.lang.Object
  extended by org.daisy.pipeline.client.models.Script

public class Script
extends java.lang.Object

A representation of a Pipeline 2 script.

Author:
jostein

Field Summary
 java.util.List<Argument> arguments
           
 Author author
           
 java.lang.String desc
           
 Homepage homepage
           
 java.lang.String href
           
 java.lang.String id
           
 java.util.List<java.lang.String> mediaTypeBlacklist
          List of mime types that are supported by more than one file argument.
 java.lang.String nicename
           
 
Constructor Summary
Script()
           
Script(org.w3c.dom.Node scriptXml)
          Parse the script described by the provided XML document/node.
Script(Pipeline2WSResponse response)
          Parse the script described by the provided Pipeline2WSResponse.
 
Method Summary
static java.util.List<Script> getScripts(org.w3c.dom.Node scriptsXml)
          Parse the list of scripts described by the provided XML document/node.
static java.util.List<Script> getScripts(Pipeline2WSResponse response)
          Parse the list of scripts described by the provided Pipeline2WSResponse.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

id

public java.lang.String id

href

public java.lang.String href

nicename

public java.lang.String nicename

desc

public java.lang.String desc

homepage

public Homepage homepage

author

public Author author

arguments

public java.util.List<Argument> arguments

mediaTypeBlacklist

public java.util.List<java.lang.String> mediaTypeBlacklist
List of mime types that are supported by more than one file argument. This is not really a part of the Web API, but are more of a convenience. A user interface cannot automatically assign files of these media types to a file argument.

Constructor Detail

Script

public Script()

Script

public Script(Pipeline2WSResponse response)
       throws Pipeline2WSException
Parse the script described by the provided Pipeline2WSResponse. Example: http://daisy-pipeline.googlecode.com/hg/webservice/samples/xml-formats/script.xml

Parameters:
response -
Throws:
Pipeline2WSException

Script

public Script(org.w3c.dom.Node scriptXml)
       throws Pipeline2WSException
Parse the script described by the provided XML document/node. Example: http://daisy-pipeline.googlecode.com/hg/webservice/samples/xml-formats/script.xml

Parameters:
scriptXml -
Throws:
Pipeline2WSException
Method Detail

getScripts

public static java.util.List<Script> getScripts(Pipeline2WSResponse response)
                                         throws Pipeline2WSException
Parse the list of scripts described by the provided Pipeline2WSResponse.

Parameters:
response -
Returns:
Throws:
Pipeline2WSException

getScripts

public static java.util.List<Script> getScripts(org.w3c.dom.Node scriptsXml)
                                         throws Pipeline2WSException
Parse the list of scripts described by the provided XML document/node. Example: http://daisy-pipeline.googlecode.com/hg/webservice/samples/xml-formats/scripts.xml

Parameters:
response -
Returns:
Throws:
Pipeline2WSException