com.highdeal.hci

Class UserOperationFilterModel

java.lang.Object

com.highdeal.hci.UserOperationFilterModel

All Implemented Interfaces:

XMLMarshallable

public class UserOperationFilterModel
extends java.lang.Object
implements XMLMarshallable

This Java class represents the user operation filter as seen by your client application.

A user operation filter allows to filter the user operations containing specific fields:

• An operation name
• An operator name (login of an SAP CC user)
• An operand reference

The operand reference can be a code or a reference if no code exists.

An operand type can be specified if some user operation results or user operation errors have to be filtered.

Note

If a field of the user operation filter is null, then all values are valid for this field.

See Also:

AuditModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="userOperationFilter">
   <xs:complexType>
     <xs:attribute name="operationName" type="xs:string"/>
     <xs:attribute name="operatorName" type="xs:string" />
     <xs:attribute name="operandType" type="OperandType" default="all"/>
     <xs:attribute name="operandReference" type="xs:string" />
   </xs:complexType>
 </xs:element>

<xs:simpleType name="OperandType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="result"/> 
     <xs:enumeration value="error"/>  
     <xs:enumeration value="all"/>  
   </xs:restriction> 
 </xs:simpleType>

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_TYPE All the types (result type and error type) for filter
static int	ERROR_TYPE The error type for filter
static int	RESULT_TYPE The result type for filter

Constructor Summary

Constructors

Constructor and Description
UserOperationFilterModel() Builds a UserOperationFilterModel object for ALL_TYPE of result.
UserOperationFilterModel(java.lang.String operationName, java.lang.String operatorName, int operandType, java.lang.String operandReference) Builds a UserOperationFilterModel object.
UserOperationFilterModel(java.lang.String operationName, java.lang.String operatorName, int operandType, java.lang.String operandReference, java.lang.String message) Builds a UserOperationFilterModel object.

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.lang.String	getMessage() Returns the message to be filtered.
java.lang.String	getOperandReference() Returns the reference of the operand to be filtered.
int	getOperandType() Returns the type of the operand (result, error, all) to be filtered.
java.lang.String	getOperationName() Returns the name of the operation to be filtered.
java.lang.String	getOperatorName() Returns the name of the operator to be filtered.
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	setMessage(java.lang.String message) Sets the message to be filtered.
void	setOperandReference(java.lang.String operandReference) Sets the reference of the operand to be filtered.
void	setOperandType(int operandType) Sets the type of the operand (result, error, all) to be filtered.
void	setOperationName(java.lang.String operationName) Sets the name of the operation to be filtered.
void	setOperatorName(java.lang.String operatorName) Sets the name of the operator to be filtered.

Methods inherited from class java.lang.Object

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

Field Detail

RESULT_TYPE

public static final int RESULT_TYPE

The result type for filter

See Also:

Constant Field Values

ERROR_TYPE

public static final int ERROR_TYPE

The error type for filter

See Also:

Constant Field Values

ALL_TYPE

public static final int ALL_TYPE

All the types (result type and error type) for filter

See Also:

Constant Field Values

Constructor Detail

UserOperationFilterModel

public UserOperationFilterModel()

Builds a UserOperationFilterModel object for ALL_TYPE of result.

UserOperationFilterModel

public UserOperationFilterModel(java.lang.String operationName,
                                java.lang.String operatorName,
                                int operandType,
                                java.lang.String operandReference,
                                java.lang.String message)

Builds a UserOperationFilterModel object.

Parameters:

operationName - The name of the user operation

operatorName - The name of operator

operandType - The type of operator

operandReference - The reference of the operand

message - The message of the operand

UserOperationFilterModel

public UserOperationFilterModel(java.lang.String operationName,
                                java.lang.String operatorName,
                                int operandType,
                                java.lang.String operandReference)

Builds a UserOperationFilterModel object.

Parameters:

operationName - The name of the users operation

operatorName - The name of operator

operandType - The type of operator

operandReference - The reference of the operand

Method Detail

getOperationName

public java.lang.String getOperationName()

Returns the name of the operation to be filtered.

Returns:

The name of the operation to be filtered

setOperationName

public void setOperationName(java.lang.String operationName)

Sets the name of the operation to be filtered.

Parameters:

operationName - The name of the operation to be filtered

getOperatorName

public java.lang.String getOperatorName()

Returns the name of the operator to be filtered.

Returns:

The name of the operator to be filtered

setOperatorName

public void setOperatorName(java.lang.String operatorName)

Sets the name of the operator to be filtered.

Parameters:

operatorName - The name of the operator to be filtered

getOperandType

public int getOperandType()

Returns the type of the operand (result, error, all) to be filtered.

Returns:

The type of the operand to be filtered

setOperandType

public void setOperandType(int operandType)

Sets the type of the operand (result, error, all) to be filtered.

Parameters:

operandType - The type of the operand to be filtered

getOperandReference

public java.lang.String getOperandReference()

Returns the reference of the operand to be filtered.

Returns:

The reference of the operand to be filtered

setOperandReference

public void setOperandReference(java.lang.String operandReference)

Sets the reference of the operand to be filtered.

Parameters:

operandReference - The reference of the operand to be filtered

getMessage

public java.lang.String getMessage()

Returns the message to be filtered.

Returns:

The message to be filtered

setMessage

public void setMessage(java.lang.String message)

Sets the message to be filtered.

Parameters:

message - The message to be filtered

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

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

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