Main Page | Packages | Class Tree | Index | Help

xp.services

class ParamsBuilder

Object
  |
  +--xp.services.ParamsBuilder

All Known Subclasses: ServiceRequest, XMLServiceRequest

class ParamsBuilder
extends Object

A helper class to build xml call params for use with the XMLConnector/XMLService.



Field Summary

public
name: String


Constructor

public
ParamsBuilder ( name: String)
Creates a new instance of the params object

Method Summary

public
addAttribute ( name: String, value: String, persist: Boolean ): Void
Adds an atribute to the root node

public
addParam ( name: String, value: Object, persist: Boolean ): Void
Adds a string param to the params

public
addXMLParam ( node: XMLNode, persist: Boolean ): Void
Adds an xml node to the params

public
bindCallParams ( params: Object ): XML
Bind all call params

public
clearAll ( ): Void
Clears all existng params

public
getCallParams ( ): XML
Gets the call params.

public
isBound ( ): Boolean
Are the params bound*



Field Documentation

name

public var name: String

Constructor Documentation

ParamsBuilder

public function ParamsBuilder(name: String)
Creates a new instance of the params object


Method Documentation

addAttribute

public function addAttribute(name: String,
 value: String,
 persist: Boolean): Void
Adds an atribute to the root node

Used for adding attributes to the root node

addParam

public function addParam(name: String,
 value: Object,
 persist: Boolean): Void
Adds a string param to the params

Appends a TextNode to the root node of the params object

addXMLParam

public function addXMLParam(node: XMLNode,
 persist: Boolean): Void
Adds an xml node to the params

Appends the node to the root node of the params

bindCallParams

public function bindCallParams(params: Object): XML
Bind all call params

Builds the callXMLParams object

clearAll

public function clearAll(): Void
Clears all existng params

getCallParams

public function getCallParams(): XML
Gets the call params.

if not yet bound this call will automatically bind them return the xml call params

isBound

public function isBound(): Boolean
Are the params bound*


The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc