Package com.highdeal.hci

Class UserOperationModel

java.lang.Object
com.highdeal.hci.UserOperationModel
All Implemented Interfaces:
XMLMarshallable
public class UserOperationModel extends Object implements XMLMarshallable
This Java class represents an audited user operation that has been processed and recorded by the SAP CC system; Your client application can consult the operation results by implement the handling of audits or by using the existing user interfaces to audit operations.

An audited user operation contains:

  • The reference of the user operation (its unique identifier in the system)
  • The name of the operation executed
  • The name of the operator (user login) that executed the operation
  • The code or the reference (if no code exists) of the operand
  • A message if an error occurred when executing the operation
  • The date when it was recorded by the system
  • The instance identifier where it was recorded by the system

Notes

  • Charging operations are not recorded by the system.
  • Search operations are only recorded if an error occurs.
See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="userOperation">
   <xs:complexType>
     <xs:attribute name="reference" type="xs:long"/>
     <xs:attribute name="operationName" type="xs:string"/>
     <xs:attribute name="operatorName" type="xs:string" />
     <xs:attribute name="operandReference" type="xs:string" />
     <xs:attribute name="message" type="xs:string" default=""/>
     <xs:attribute name="recordingDate" type="xs:dateTime"/>
     <xs:attribute name="instanceId" type="xs:string"/>
   </xs:complexType>
 </xs:element>

  • Constructor Details

    • UserOperationModel

      public UserOperationModel()
      Creates an uninitialized user operation.

    • UserOperationModel

      @Deprecated public UserOperationModel(String operationName, String operatorName, String operandReference, Date recordingDate)
      Deprecated.
      Creates a user operation for a successful execution (no error message is specified).
      Parameters:
      operationName - The name of the operation executed
      operatorName - The name of the operator (user login) which executed the operation
      operandReference - The code or the reference (if no code exists) of the operand
      recordingDate - The date when the operation was recorded by the system

    • UserOperationModel

      public UserOperationModel(String operationName, String operatorName, String operandReference, Date recordingDate, String instanceId)
      Creates a user operation for a successful execution (no error message is specified) and an instance identifier.
      Parameters:
      operationName - The name of the operation executed
      operatorName - The name of the operator (user login) which executed the operation
      operandReference - The code or the reference (if no code exists) of the operand
      recordingDate - The date when the operation was recorded by the system
      instanceId - The instance identifier where the operation was audited

    • UserOperationModel

      @Deprecated public UserOperationModel(String operationName, String operatorName, String operandReference, String message, Date recordingDate)
      Deprecated.
      Creates a user operation for a failed execution (an error message is specified).
      Parameters:
      operationName - The name of the operation executed
      operatorName - The name of the operator (user login) which executed the operation
      operandReference - The code or the reference (if no code exists) of the operand
      message - The code or the reference (if no code exists) of the operand
      recordingDate - The date when the operation was recorded by the system

    • UserOperationModel

      public UserOperationModel(String operationName, String operatorName, String operandReference, String message, Date recordingDate, String instanceId)
      Creates a user operation for a failed execution (an error message is specified) and an instance identifier.
      Parameters:
      operationName - The name of the operation executed
      operatorName - The name of the operator (user login) which executed the operation
      operandReference - The code or the reference (if no code exists) of the operand
      message - The code or the reference (if no code exists) of the operand
      recordingDate - The date when the operation was recorded by the system
      instanceId - The instance identifier where the operation was audited

  • Method Details

    • getOperationName

      public String getOperationName()
      Returns the name of the operation executed.
      Returns:
      The name of the operation executed

    • setOperationName

      public void setOperationName(String operationName)
      Sets the name of the operation executed.
      Parameters:
      operationName - The name of the operation executed

    • getOperatorName

      public String getOperatorName()
      Returns the name of the operator (user login) which executed the operation.
      Returns:
      The name of the operator (user login) which executed the operation

    • setOperatorName

      public void setOperatorName(String operatorName)
      Sets the name of the operator (user login) which executed the operation.
      Parameters:
      operatorName - The name of the operator (user login) which executed the operation

    • getOperandReference

      public String getOperandReference()
      Returns the code or the reference (if no code exists) of the operand.
      Returns:
      The code or the reference (if no code exists) of the operand

    • setOperandReference

      public void setOperandReference(String operandReference)
      Sets the code or the reference (if no code exists) of the operand.
      Parameters:
      operandReference - The code or the reference (if no code exists) of the operand

    • getMessage

      public String getMessage()
      Returns the message of the error.
      Returns:
      The message of the error

    • setMessage

      public void setMessage(String message)
      Sets the message of the error.
      Parameters:
      message - The message of the error

    • getRecordingDate

      public Date getRecordingDate()
      Returns the date when the operation was recorded by the system.
      Returns:
      The date when the operation was recorded by the system

    • setRecordingDate

      public void setRecordingDate(Date recordingDate)
      Sets the date when the operation was recorded by the system.
      Parameters:
      recordingDate - The date when the operation was recorded by the system

    • getReference

      public long getReference()
      Returns the reference of the user operation (its unique identifier in the system).
      Returns:
      The reference of the user operation (its unique identifier in the system)

    • setReference

      public void setReference(long reference)
      Sets the reference of the user operation (its unique identifier in the system).
      Parameters:
      reference - The reference of the user operation (its unique identifier in the system)

    • getInstanceId

      public String getInstanceId()
      Returns the instance identifier where the operation was audited.
      Returns:
      The instance identifier where the operation was audited

    • setInstanceId

      public void setInstanceId(String instanceId)
      Sets the instance identifier where the operation was audited.
      Parameters:
      instanceId - The instance identifier where the operation was audited

    • addChild

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

    • 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

    • 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