com.ibm.events.access
Class UpdateEventAttribute

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

public class UpdateEventAttribute
extends java.lang.Object
implements EventChangeRequest

A change request used for updating base attribute of an event.

Since:
6.0.0
Version:
1.3 1/10/06
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
UpdateEventAttribute(java.lang.String globalInstanceId)
          Creates a new UpdateEventAttribute object.
 
Method Summary
 int getChangeRequestType()
          Get the type of change request this object represents.
 long getElapsedTime()
          Get the new value for elapsed time.
 java.lang.String getGlobalInstanceId()
          Get the global instance ID of the event that this change request is modifying.
 short getPriority()
          Get the new value for priority.
 short getRepeatCount()
          Get the new value for repeat count.
 short getSeverity()
          Get the new value for severity.
 boolean isElapsedTimeSet()
          Verify if an elapsed time value is set for this change request.
 boolean isPrioritySet()
          Verify if a priority value is set for this change request.
 boolean isRepeatCountSet()
          Verify if a repeat count value is set for this change request.
 boolean isSeveritySet()
          Verify if a severity value is set for this change request.
 void setElapsedTime(long elapsedTime)
          Set a new elapsed time value for the attribute change change request.
 void setPriority(short priority)
          Set a new priority value for the attribute change change request.
 void setRepeatCount(short repeatCount)
          Set a new repeat count value for the attribute change change request.
 void setSeverity(short severity)
          Set a new severity value for the attribute change change request.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UpdateEventAttribute

public UpdateEventAttribute(java.lang.String globalInstanceId)
Creates a new UpdateEventAttribute object.

Parameters:
globalInstanceId - The global instance ID of the event whose attributes will be updated.
Throws:
java.lang.IllegalArgumentException - If globalInstanceId is null or 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()

setElapsedTime

public void setElapsedTime(long elapsedTime)
Set a new elapsed time value for the attribute change change request.

Parameters:
elapsedTime - The value to set the elapsed time to.

getElapsedTime

public long getElapsedTime()
Get the new value for elapsed time. If this call returns 0 then a call to isElapsedTimeSet should be done to verify that value has been set to 0.

Returns:
The new value for elapsed time.

isElapsedTimeSet

public boolean isElapsedTimeSet()
Verify if an elapsed time value is set for this change request.

Returns:
true if a elapsed time value is set, false otherwise.

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

setPriority

public void setPriority(short priority)
Set a new priority value for the attribute change change request.

Parameters:
priority - The value to set the priority to.
Throws:
java.lang.IllegalArgumentException - If priority is not a value from 0 to 100.

getPriority

public short getPriority()
Get the new value for priority. If this call returns 0 then a call to isPrioritySet should be done to verify that value has been set to 0.

Returns:
The new value for priority.

isPrioritySet

public boolean isPrioritySet()
Verify if a priority value is set for this change request.

Returns:
true if a priority value is set, false otherwise.

setRepeatCount

public void setRepeatCount(short repeatCount)
Set a new repeat count value for the attribute change change request.

Parameters:
repeatCount - The value to set the repeat count to.
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!

getRepeatCount

public short getRepeatCount()
Get the new value for repeat count. If this call returns 0 then a call to isRepeatCountSet should be done to verify that value has been set to 0.

Returns:
The new value for repeat count.

isRepeatCountSet

public boolean isRepeatCountSet()
Verify if a repeat count value is set for this change request.

Returns:
true if a repeat count value is set, false otherwise.

setSeverity

public void setSeverity(short severity)
Set a new severity value for the attribute change change request.

Parameters:
severity - The value to set the severity to.
Throws:
java.lang.IllegalArgumentException - If severity is not a value from 0 to 70.

getSeverity

public short getSeverity()
Get the new value for severity. If this call returns 0 then a call to isSeveritySet should be done to verify that value has been set to 0.

Returns:
The new value for severity.

isSeveritySet

public boolean isSeveritySet()
Verify if a severity value is set for this change request.

Returns:
true if a severity value is set, false otherwise.

toString

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