com.highdeal.admin.hci

Class GetLogTracesResult

java.lang.Object

com.highdeal.admin.hci.GetLogTracesResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class GetLogTracesResult
extends java.lang.Object
implements OperationResult

This class represents the result of the Get Logs and Traces operation; It contains a Vector of the latest entries of the logs and traces of the responding instance of the SAP CC system.

Implementation in Your Client Application

Use getLogTraces() to get the resulting vector.

Operation Request

GetLogTracesOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="getLogTracesResult">
   <xs:complexType>
     <xs:sequence>
         <xs:element name="logs" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
            <xs:attribute name="trace" type="xs:string"/>
        </xs:complexType>
         </xs:element>
     </xs:sequence>
     <xs:attribute name="enabled" type="xs:boolean"/>
   </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOGS_NAME The name of the tag for internal log entry in the main getLogTracesResult XML element
static java.lang.String	OPERATION_NAME The name of this operation: "getLogTracesResult"

Constructor Summary

Constructors

Constructor and Description
GetLogTracesResult() Initiliazes a new instance of GetLogTracesResult.
GetLogTracesResult(java.lang.String[] t) Initiliazes a new instance of GetLogTracesResult with an array of log traces.

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.
java.util.Vector<java.lang.String>	getLogTraces() Fetches the logs and traces as a vector of strings (each line of the file becomes a string).
java.lang.String	getName() Returns the name of the operation, that is "getLogTracesResult".
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.
boolean	isEnabled() Returns true if logs are enabled on the server, false otherwise.
void	marshal(XMLOutputter output) Writes the operation XML data to the given output.
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

The name of this operation: "getLogTracesResult"

See Also:

Constant Field Values

LOGS_NAME

public static final java.lang.String LOGS_NAME

The name of the tag for internal log entry in the main getLogTracesResult XML element

See Also:

Constant Field Values

Constructor Detail

GetLogTracesResult

public GetLogTracesResult()

Initiliazes a new instance of GetLogTracesResult.

GetLogTracesResult

public GetLogTracesResult(java.lang.String[] t)

Initiliazes a new instance of GetLogTracesResult with an array of log traces.

Parameters:

t - An array of logs and traces

Method Detail

getName

public java.lang.String getName()

Returns the name of the operation, that is "getLogTracesResult".

Returns:

OPERATION_NAME

getLogTraces

public java.util.Vector<java.lang.String> getLogTraces()

Fetches the logs and traces as a vector of strings (each line of the file becomes a string).

Returns:

A vector of string, one for each log or trace

isEnabled

public boolean isEnabled()

Returns true if logs are enabled on the server, false otherwise.

Returns:

true if logs are enable on the server, 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

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)

Writes the operation XML data to the given output.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XMLOutputter to write into