com.highdeal.admin.hci

Class ListClientsResult

java.lang.Object

com.highdeal.admin.hci.ListClientsResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class ListClientsResult
extends java.lang.Object
implements OperationResult

This class represents the response of a List Clients operation; It contains the list of charging clients connected to the SAP CC Core Server system.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="listClientsResult">
   <xs:complexType>
     <xs:sequence>
        <xs:element ref="clientInfo" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESULT_NAME The XML name of the operation result: "listClientsResult"

Constructor Summary

Constructors

Constructor and Description
ListClientsResult() Creates a list clients result.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
void	addClientInfo(ClientInfo clientInfo) Adds a ClientInfo to the result.
java.util.List<ClientInfo>	getClientInfos() Gets the list of ClientInfo contained in the result.
java.lang.String	getOperandReference() Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setClientInfos(java.util.List<ClientInfo> clientInfos) Sets the list of ClientInfo contained in the result.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESULT_NAME

public static final java.lang.String RESULT_NAME

The XML name of the operation result: "listClientsResult"

See Also:

Constant Field Values

Constructor Detail

ListClientsResult

public ListClientsResult()

Creates a list clients result.

Method Detail

getOperandReference

public java.lang.String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Specified by:

getOperandReference in interface OperationResult

Returns:

The operand reference of the operation result

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into

getClientInfos

public java.util.List<ClientInfo> getClientInfos()

Gets the list of ClientInfo contained in the result.

Returns:

The list of ClientInfo contained in the result

setClientInfos

public void setClientInfos(java.util.List<ClientInfo> clientInfos)

Sets the list of ClientInfo contained in the result.

Parameters:

clientInfos - The list of ClientInfo contained in the result

addClientInfo

public void addClientInfo(ClientInfo clientInfo)

Adds a ClientInfo to the result.

Parameters:

clientInfo - The ClientInfo to add to the result