Skip to content

com_vuzit_OptionList

bmatzelle edited this page Sep 13, 2010 · 1 revision

com.vuzit.OptionList class

Class for handling optional parameters for methods. These options can then be directly applied to the web service parameters.

Methods

Properties for the class.

  • int count() : Returns the number of items in the list.
  • Enumeration keys() : Returns the list of keys from the list.
  • String get(key) : Returns the value of the key.
  • public OptionList add(String key, String value)
  • public OptionList add(String key, int value)
  • public OptionList add(String key, boolean value)
  • public bool contains(string key)

Parameters

Parameters for the methods of this class.

  • String key : The name of a key.
  • String value : String value for the key.
  • boolean value : Boolean value for the key.
  • int value : Integer value for the key.

Usage Examples

Example that sets the “secure” and “file_type” options for the document.


// The following upload command and all subsequent commands will be executed under SSL
com.vuzit.Document doc = com.vuzit.Document.upload("c:\path\to\document.pdf", 
                                                   new com.vuzit.OptionList()
                                                      .add("secure", true)
                                                      .add("file_type", "pdf"));  
System.out.println("Document id: " + doc.Id);

Clone this wiki locally