Modifying XML Schemas

In this section:

Every method and constructor has specific XML request and response schemas. A constructor item will be displayed under an Assembly node within the hierarchy of iWay Explorer only if users enable the cache for that Assembly. In order to allow users to reuse the object on which to invoke a method, a new string data type called sessionid is defined in the schemas that are generated in iWay Explorer. This identifies a unique object. When users want to execute a method of an instance of a class, they can either pass the information of a constructor through a schema to create a new instance or pass a sessionid through schema to reuse a previously created instance for the class. For a cacheable Assembly, a sessionid is returned in a response from a constructor request or method request.


Top of page

x
Constructor Schemas

The following image is an example of a request schema for a constructor.

The following image is an example of a response schema for a constructor.


Top of page

x
Method Schemas

The following image is an example of a request schema for a method.

The following image is an example of a response schema for a method.


Top of page

x
Schema Properties Reference

In the XML request and response schemas for constructors and methods provided in this example:

[NAMESPACE]

Is the name of a namespace.

[COMPLEXTYPENAME]

Is the name of a complex type.

[CONSTRUCTORNAME]

Is the name of a constructor of a class.

[ELEMENTNAME]

Is the name of an argument of a constructor or a name of a parameter of a method.

[COMPLEXTYPE]

Is a complex type, which is equal to:

"tns:" + [COMPLEXTYPENAME]
[BUILTINTYPENAME]

Is the name of a built-in data type.

[BUILTINTYPE]

Is a built-in data type, which is equal to:

"xs:" + [BUILTINTYPENAME]
[ASSEMBLYPATH]

Is the location of an Assembly.

[METHODSIGNATURE]

Is the signature of a method. This is a combination of the name of the method and the number and types of parameters (and their order).

[CONSTRUCTORSIGNATURE]

Is the signature of a constructor. This is a combination of the name of the constructor and the number and types of arguments (and their order).

[FULLCLASSNAME]

Is the combination of the namespace of the class along with the period character (.) and the name of the class.

[CONSTRUCTORPATH]

Is the following:

[ASSEMBLYPATH]/[FULLCLASSNAME]/[CONSTRUCTORSIGNATURE]
[METHODPATH]

Is the following:

[ASSEMBLYPATH]/[FULLCLASSNAME]/[METHODSIGNATURE]
[CONSTRUCTORRESPONSE]

Is the combination of a name of a constructor along with the string Response.

[METHODRESPONSE]

Is the combination of a name of a method along with the string Response.

[UCONSTRUCTORNAME]

Is a unique name of an identified onstructor of a class.

If a class only contains one constructor, then:

[UCONSTRUCTORNAME]=[CONSTRUCTORNAME]

If a class contains multiple constructors, then:

[UCONSTRUCTORNAME]=[CONSTRUCTORNAME]+"_"+string of a positive number
[METHODNAME]

Is the name of a method.

The following fragment represents a node of a complex type:

"+<xs:complexType name="[COMPLEXTYPENAME]">

Top of page

x
Expanding Nodes Based on Different Complex Types

You can expand nodes based on different complex types of nodes, as shown in the schema fragments in this section.



x
System.Collections.ArrayList Type



x
System.Collections.Generic.Dictionary Type

[DICTIONARYNAME]

Is the name of dictionary, which is the combination of the string ArrayOfKeyValueOf along with [DICTIONARYKEYVALUENAME].

[DICTIONARYKEYVALUENAME]

Is the data, which is the combination of the string of key type along with the string of value type.



x
Array or System.Collections.Generic.List Type

[ARRAYNAME]

Is the name of an array, which is the combination of the string ArrayOf along with the string of a data type.



x
Pointer Type



x
Constructor Type


Top of page

x
Complete XML Request Schema


iWay Software