Sepasoft MES Module Suite
The WSElement object is used to hold the individual elements defined in the schema for a web service that represent the header, body, input and output.
Properties
addChild()
Description
This script function will add a child to the existing WSElement.
Syntax
addChild(child)
- Parameters
WSElement child - The child object to be added.
- Returns
Nothing
- Scope
All
getChild()
Description
Returns the WSElement at this index in the child WSElement list.
Syntax
getChild(index)
- Parameters
int index - The index of the child to be returned for.
- Returns
The child specified by the index.
- Scope
All
getChild(name)
Description
Retrieves a child specified by the name.
Syntax
getChild(childName)
- Parameters
String childName - The name of the child to be returned for.
- Returns
The WSElement associated with this child name.
- Scope
All
getChildNames()
Description
Returns all child names of the WSElement contained in this WSElement.
Syntax
getChildNames()
- Parameters
None
- Returns
List names - The list of names of all the children for this WSElement.
- Scope
All
getChildren()
Description
Returns a list of WSElements contained in this WSElement.
Syntax
getChildren()
- Parameters
None
- Returns
List children - All the children for this WSElement.
- Scope
All
getFullName()
Description
Returns a String representing the "." separated name of this WSElement and it's parent.
Syntax
getFullName()
- Parameters
None
- Returns
String name - The full name of this WSElement.
- Scope
All
getMaxOccurrences()
Description
Returns maximum occurrences this element can appear.
Syntax
getMaxOccurrences()
- Parameters
None
- Returns
int maxOcurrences - The integer representing the maximum number of occurrences.
- Scope
All
getName()
Description
Returns the name of this WSElement.
Syntax
getName()
- Parameters
None
- Returns
String name - The name of this WSElement.
- Scope
All
getParent()
Description
Returns the parent of this WSElement.
Syntax
getParent()
- Parameters
None
- Returns
WSElement parent - The parent for this WSElement.
- Scope
All
getQualifiedName()
Description
Returns the qualified name of this WSElement.
Syntax
getQualifiedName()
- Parameters
None
- Returns
String qualifiedName - The qualified name for this WSElement.
- Scope
All
getType()
Description
Returns WSType of this element.
Syntax
getType()
- Parameters
None
- Returns
The WSType for this element.
- Scope
All
getTypeName()
Description
Returns WSType of this element. Can be 'Complex', 'Simple' or 'Restricted'.
Syntax
getTypeName()
- Parameters
None
- Returns
String typeName - The type of this WSElement.
- Scope
All
isOptional()
Description
Returns true if this element is optional.
Syntax
isOptional()
- Parameters
None
- Returns
boolean optional - True if this element should be optional and False otherwise.
- Scope
All
setChildren(children)
Description
Sets a list of WSElements as the children for this WSElement.
Syntax
setChildren(children)
- Parameters
List children - Children to be set for this WSElement.
- Returns
Nothing
- Scope
All
setDataType(typeName)
Description
Sets the data type for the WSElement.
Syntax
setDataType(typeName)
- Parameters
String typeName - The data type to be set for. String is the default data type.
- Returns
Nothing
- Scope
All
setMaxOccurrences(maxOccurrences)
Description
Sets the maximum occurrences for this WSElement.
Syntax
setMaxOccurrences(maxOccurrences)
- Parameters
int maxOcurrences - The integer representing the maximum number of occurrences.
- Returns
Nothing
- Scope
All
setName()
Description
Sets the name of this WSElement.
Syntax
setName()
- Parameters
String name - The name of the WSElement to be set for.
- Returns
The name of the WSElement.
- Scope
All
setOptional()
Description
Set to true if this element should be optional or False otherwise.
Syntax
setOptional()
- Parameters
boolean optional - True if this element should be optional and False otherwise.
- Returns
Nothing
- Scope
All
setParent(parent)
Description
Sets the parent for this WSElement.
Syntax
setParent(parent)
- Parameters
WSElement parent - The parent for this WSElement.
- Returns
Nothing
- Scope
All
setQualifiedName(qualifiedName)
Description
Sets the qualified name for this WSElement.
Syntax
setQualifiedName(qualifiedName)
- Parameters
String name - The qualified name for this WSElement.
- Returns
Nothing
- Scope
All
setType(type)
Description
Returns WSType of this element.
Syntax
setType(type)
- Parameters
WSType type - The type to be set for.
- Returns
Nothing
- Scope
All
setTypeName(typeName)
Description
Returns WSType of this element. Can be 'Complex', 'Simple' or 'Restricted'.
Syntax
setTypeName(typeName)
- Parameters
String typeName - The type to be set for this WSElement.
- Returns
The WS type for this element.
- Scope
All
sortChildren()
Description
Sorts the WSElements to simple and complex children.
Syntax
sortChildren()
- Parameters
None
- Returns
Nothing
- Scope
All
Sepasoft MES Module Suite