com.ibm.events.access
Class AddContextDataElement

java.lang.Object
  extended bycom.ibm.events.access.AddContextDataElement
All Implemented Interfaces:
EventChangeRequest, java.io.Serializable

public class AddContextDataElement
extends java.lang.Object
implements EventChangeRequest

A change request used for adding context data elements.

Since:
6.0.0
Version:
1.3 5/7/07
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.ibm.events.access.EventChangeRequest
ADD_CONTEXT_DATA_ELEMENT_CHANGE_REQUEST, ADD_EXTENDED_DATA_ELEMENT_CHANGE_REQUEST, CBE_XPATH_LOCATION_PREFIX, CHANGE_REQUEST_STRINGS, CREATE_EMPTY_EXTENDED_DATA_ELEMENT_CHANGE_REQUEST, UPDATE_ATTRIBUTE_CHANGE_REQUEST, UPDATE_EVENT_ASSOCIATION_CHANGE_REQUEST, UPDATE_EXTENDED_DATA_ELEMENT_CHANGE_REQUEST
 
Constructor Summary
AddContextDataElement(java.lang.String globalInstanceId, org.eclipse.hyades.logging.events.cbe.ContextDataElement contextDataElement)
          Creates a new AddContextDataElement object.
 
Method Summary
 int getChangeRequestType()
          Get the type of change request this object represents.
 org.eclipse.hyades.logging.events.cbe.ContextDataElement getContextDataElement()
          Get the context data element that is being added to the event.
 java.lang.String getGlobalInstanceId()
          Get the global instance ID of the event that this change request is modifying.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AddContextDataElement

public AddContextDataElement(java.lang.String globalInstanceId,
                             org.eclipse.hyades.logging.events.cbe.ContextDataElement contextDataElement)
Creates a new AddContextDataElement object.

Parameters:
globalInstanceId - The global instance ID of the event whose attributes will be updated.
contextDataElement - The context data element to add.
Throws:
java.lang.IllegalArgumentException - If one of the following conditions occur
  1. any of the parameters are null
  2. contextDataElement is not valid.
Method Detail

getChangeRequestType

public int getChangeRequestType()
Description copied from interface: EventChangeRequest
Get the type of change request this object represents.

Specified by:
getChangeRequestType in interface EventChangeRequest
Returns:
An integer that matches to one of the change request type constants found in the interface EventChangeRequest.
See Also:
EventChangeRequest.getChangeRequestType()

getContextDataElement

public org.eclipse.hyades.logging.events.cbe.ContextDataElement getContextDataElement()
Get the context data element that is being added to the event.

Returns:
The context data element being added to the event.

getGlobalInstanceId

public java.lang.String getGlobalInstanceId()
Description copied from interface: EventChangeRequest
Get the global instance ID of the event that this change request is modifying.

Specified by:
getGlobalInstanceId in interface EventChangeRequest
Returns:
A string representing the global instance ID of the event that this change request is updating.
See Also:
EventChangeRequest.getGlobalInstanceId()

toString

public java.lang.String toString()
See Also:
Object.toString()