com.highdeal.hci

Class SearchAuditsOp

java.lang.Object

com.highdeal.hci.SearchAuditsOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class SearchAuditsOp
extends Object
implements MessageOperation

This operation allows you to search an audit from a specified code; If you specify a null code, then all the audits are retrieved.

Operation Result

SearchAuditsResult

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchAudits">
   <xs:complexType>
     <xs:attribute name="code" type="xs:string"/>
     <xs:attribute name="fetchOps" type="xs:boolean"/>
   </xs:complexType>
 </xs:element>

Operation Availability

You can send this operation request in HCI messages to the following final target types of instances in the connected SAP CC system:

Edition	Final Target Instances
	rater	updater	guider	bulkLoader	taxer	dispatcher
charge	No	Yes	No	No	No	No

Audit Domain

This operation is audited as part of the audit domain TECHNICAL

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_NAME The XML tag name of the operation: "searchAudits"

Constructor Summary

Constructors

Constructor and Description
SearchAuditsOp()

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String name, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
String	getCode() Gets the code of audit to be found.
boolean	getFetchOps() Returns whether the result of this operation brings the user operations back.
String	getName() Gets the name of the operation.
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	setCode(String code) Sets the code of audit to be found.
void	setFetchOps(boolean fetch) Sets whether the result of this operation brings the user operations back.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final String OPERATION_NAME

The XML tag name of the operation: "searchAudits"

See Also:

Constant Field Values

Constructor Detail

SearchAuditsOp

public SearchAuditsOp()

Method Detail

getName

public String getName()

Gets the name of the operation.

Specified by:

getName in interface MessageOperation

Returns:

"searchAudits"

getCode

public String getCode()

Gets the code of audit to be found.

Returns:

The code of audit

setCode

public void setCode(String code)

Sets the code of audit to be found.

Parameters:

code - The code of audit

getFetchOps

public boolean getFetchOps()

Returns whether the result of this operation brings the user operations back.

Returns:

whether the result of this operation brings the user operations back.

setFetchOps

public void setFetchOps(boolean fetch)

Sets whether the result of this operation brings the user operations back.

Parameters:

fetch - whether the result of this operation brings the user operations back.

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

addChild

public void addChild(String name,
                     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:

name - The name of tag for the child

child - The child to be added

addCharacterData

public void addCharacterData(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

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