com.ibm.events.access
Class UpdateEventAssociation

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

public class UpdateEventAssociation
extends java.lang.Object
implements EventChangeRequest

A change request used for updating event associations.

If the association engine does not exist then one will be created.

Since:
6.0.0
Version:
1.2 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
UpdateEventAssociation(java.lang.String globalInstanceId, org.eclipse.hyades.logging.events.cbe.AssociationEngine associationEngine, java.lang.String[] additionalResolvedEvents)
          Creates a new UpdateEventAssociation object.
 
Method Summary
 java.lang.String[] getAdditionalResolvedEvents()
          Get an array of additional global instance ID’s of events that should be associated to the event with the global instance ID returned from getGlobalInstanceId.
 org.eclipse.hyades.logging.events.cbe.AssociationEngine getAssociationEngine()
          Get the association engine that was used to associate the events.
 int getChangeRequestType()
          Get the type of change request this object represents.
 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

UpdateEventAssociation

public UpdateEventAssociation(java.lang.String globalInstanceId,
                              org.eclipse.hyades.logging.events.cbe.AssociationEngine associationEngine,
                              java.lang.String[] additionalResolvedEvents)
Creates a new UpdateEventAssociation object.

Parameters:
globalInstanceId - The global instance ID of the event whose attributes will be updated.
associationEngine - The association engine used to associate events.
additionalResolvedEvents - Array of global instance IDs to be associated to the event specified by globalInstanceId.
Throws:
java.lang.IllegalArgumentException - If one of the following conditions occur
  1. any of the parameters are null
  2. additionalResolvedEvents is an empty array or has a null element
  3. associationEngine is not valid
Method Detail

getAdditionalResolvedEvents

public java.lang.String[] getAdditionalResolvedEvents()
Get an array of additional global instance ID’s of events that should be associated to the event with the global instance ID returned from getGlobalInstanceId.

Returns:
An array of global instance ID’s that is associated to an event.

getAssociationEngine

public org.eclipse.hyades.logging.events.cbe.AssociationEngine getAssociationEngine()
Get the association engine that was used to associate the events.

Returns:
The association engine used to associate events.

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

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