Parsing List Type OutputXml

 

Function Name: getVal

 

Class: com.newgen.dmsapi.DMSXmlResponse

 

Description: This function is used to retrieve the value corresponding to the given tag sent in the Output Xml of an Object of the List. skip() function can be used to move the Pointer to the next Object.

 

Input Parameters

Output Parameters

 

Prototype:

public String getVal

(

 

 

 

String tag

 

)

 

 

 

Input Parameters:

Name

Description

Valid Values

Tag

Name of the tag whose value has to be retrieved.

 

 

Output Parameters:

String type of value of the tag. If no value is returned for the specified tag in the Output Xml or if the tag does not exists, then the returned value is an empty String.

 

 

Function Name: createList

 

Class: com.newgen.dmsapi.DMSXmlResponse

 

Description: This function is used to generate the List to parse List type OutputXml. API of DMSXmlList can then be used to parse each Object in the List.

 

Input Parameters

Output Parameters

 

Prototype:

public DMSXmlList createList

(

 

 

 

String listStartTag, String elementTag

 

)

 

 

 

Input Parameters:

Name

Description

Valid Values

listStartTag

Name of the Parent tag.

 

elementTag

Name of the child tag for which the List has to be generated.

 

 

Output Parameters:

The Output is an Object of DMSXmlList.

 

 

Function Name: reInitialize

 

Class: com.newgen.dmsapi.DMSXmlList

 

Description: This function is used to move the Pointer to the beginning of the List.

 

 

Input Parameters

Output Parameters

 

Prototype:

public void reInitialize()

 

 

Input Parameters:

None

 

Output Parameters:

None

 

 

 

Function Name: reInitialize

 

Class: com.newgen.dmsapi.DMSXmlList

 

Description: This function is used to move the Pointer to the beginning of the List or to the end of the List depending on the Input parameter.

 

Input Parameters

Output Parameters

 

Prototype:

public void reInitialize

(

 

 

 

boolean isAscending

 

)

 

 

 

Input Parameters:

Name

Description

Valid Values

Default Behaviour

isAscending

This parameter determines whether the Pointer is to be taken to the beginning or end of the List.

True, if the List is to be parsed in ascending order.

False, if the List is to be parsed in ascending order.

True / False

 

 

Output Parameters:

None

 

 

Function Name: hasMoreElements

 

Class: com.newgen.dmsapi.DMSXmlList

 

Description: This function tests if the List contains any more Elements.

 

Input Parameters

Output Parameters

 

Prototype:

public boolean hasMoreElements()

 

 

Input Parameters:

None

 

Output Parameters:

Returns true, if the List contains at least one more Objects ; false, otherwise.

 

 

Function Name: hasMoreElements

 

Class: com.newgen.dmsapi.DMSXmlList

 

Description: This function tests if this List contains any more Elements in forward or backward direction depending on the Input parameter.

 

Input Parameters

Output Parameters

 

Prototype:

public boolean hasMoreElements

(

 

 

 

boolean isAscending

 

)

 

 

 

Input Parameters:

Name

Description

Valid Values

Default Behaviour

isAscending

Used to check whether the next Object exists in the List in the specified direction. 

True, in case of checks for the Object in forward direction.

False, in case of checks for the Object in Backward direction .

True / False

 

 

Output Parameters:

Returns true, if the List contains at least one more Objects; false, otherwise.

 

Function Name: skip

 

Class: com.newgen.dmsapi.DMSXmlList

 

Description: This function is used to traverse the XML List. It moves the Pointer to the next Object in the XML List in forward direction.

 

Input Parameters

Output Parameters

 

Prototype:

public void skip()

 

 

Input Parameters:

None

 

Output Parameters:

None

 

 

Function Name: skip

 

Class: com.newgen.dmsapi.DMSXmlList

 

Description: This function is used to traverse the XML List. It moves the Pointer to the next Object in the XML List in forward or backward direction, depending on the Input parameter.

 

Input Parameters

Output Parameters

 

Prototype:

public void skip

(

 

 

 

boolean isAscending

 

)

 

 

 

Input Parameters:

Name

Description

Valid Values

Default Behaviour

isAscending

This parameter is used to skip to the next or previous Object in the List.

True, moves to the next Object in the List.

False, moves to previous Object in the List.

True / False

 

 

 

Output Parameters:

None