com.highdeal.admin.hci

Class SwitchDBFileDirectoriesResult

java.lang.Object

com.highdeal.admin.hci.SwitchDBFileDirectoriesResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class SwitchDBFileDirectoriesResult
extends java.lang.Object
implements OperationResult

This class represents the result of the Switch DB File Directories operation.

The result contains an overall execution status.

This response is returned when the bulk loading operation has successfully ended.

Operation Request

SwitchDBFileDirectoriesOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="switchDBFileDirectoriesResult">
   <xs:complexType>
     <xs:attribute name="allFilesLoaded" type="xs:boolean" default="false" />
   </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_NAME Te XML name of the operation result: [@value OPERATION_NAME}

Constructor Summary

Constructors

Constructor and Description
SwitchDBFileDirectoriesResult() Builds an empty SwitchDBFileDirectoriesResult.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String data) 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.
boolean	getAllFilesLoaded() Retrieves whether all files have been bulkloaded properly.
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	setAllFilesLoaded(boolean allFilesLoaded) Specifies whether all files have been loaded properly.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

Te XML name of the operation result: [@value OPERATION_NAME}

See Also:

Constant Field Values

Constructor Detail

SwitchDBFileDirectoriesResult

public SwitchDBFileDirectoriesResult()

Builds an empty SwitchDBFileDirectoriesResult.

Method Detail

getAllFilesLoaded

public boolean getAllFilesLoaded()

Retrieves whether all files have been bulkloaded properly.

Returns:

true if the corresponding SwitchDBFileDirectoriesOp operation request was set to check file loading and if all files have been loaded properly, false otherwise

setAllFilesLoaded

public void setAllFilesLoaded(boolean allFilesLoaded)

Specifies whether all files have been loaded properly.

Parameters:

allFilesLoaded - true if all files have been loaded properly, false otherwise

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

addCharacterData

public void addCharacterData(java.lang.String data)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

data - 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

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