Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKEventDefICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKEventDefICM

public class DKEventDefICM
extends java.lang.Object

The DKEventDefICM class defines methods for accessing Eevent-related information. It contains records related to CRUD (create, retrieve, update and delete) operations on items. Events logged by the server depends on the item event flag defined in the item type class. Events related to the actions of library server users when working on items may also be logged. After the data for an event is created, it cannot be updated.

See Also:

Constructor Summary
DKEventDefICM(dkDatastore ds)
          Constructs the definition of an event for the specified ICM datastore
 
Method Summary
 DKTimestamp createTimestamp()
          Retrieves the time stamp for when the event entry was created.
 int getCode()
          Retrieves the value of the event code.
 java.lang.String getEventData1()
          Retrieves the data for this event
 java.lang.String getEventData2()
          Retrieves the data for this event
 java.lang.String getEventData3()
          Retrieves the data for this event
 java.lang.String getEventData4()
          Retrieves the data for this event
 java.lang.String getEventData5()
          Retrieves the data for this event
 int getEventDataCount()
          Retrieves the value of the event data count
 java.lang.String getItemId()
          Retrieves the the identifier for the item associated with this this event.
 void setEventData1(java.lang.String eventData1)
          Sets the event data of this event to the specified value.
 void setEventData2(java.lang.String eventData2)
          Sets the event data of this event to the specified value.
 void setEventData3(java.lang.String eventData3)
          Sets the event data of this event to the specified value.
 void setEventData4(java.lang.String eventData4)
          Sets the event data of this event to the specified value.
 void setEventData5(java.lang.String eventData5)
          Sets the event data of this event to the specified value.
 void setEventDataCount(int eventDataCount)
          Sets the value of the event data count
 java.lang.String userId()
          Retrieves the identifier for the user who created the event
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKEventDefICM

public DKEventDefICM(dkDatastore ds)
Constructs the definition of an event for the specified ICM datastore
Parameters:
ds - - datastore object as an instance of DKDatastoreICM
Method Detail

createTimestamp

public DKTimestamp createTimestamp()
Retrieves the time stamp for when the event entry was created. This value cannot be updated by the application
Returns:
timestamp of event creation as an instance of DKTimestamp

userId

public java.lang.String userId()
Retrieves the identifier for the user who created the event
Returns:
user identifier as a string variable

getCode

public int getCode()
Retrieves the value of the event code. The event code allows the classification of events with similar purposes into groups. Only positive values are allowed. Applications are not allowed to update this field
Returns:
event definition code as an integer value

getEventDataCount

public int getEventDataCount()
Retrieves the value of the event data count
Returns:
event data count as an integer value

setEventDataCount

public void setEventDataCount(int eventDataCount)
Sets the value of the event data count
Parameters:
eventDataCount - - event data count value to be assigned to this event

getItemId

public java.lang.String getItemId()
Retrieves the the identifier for the item associated with this this event. This value is set automatically by the system when a CRUD operation is performed on an item and cannot be updated by the application
Returns:
item identifier for this event as a string

getEventData1

public java.lang.String getEventData1()
Retrieves the data for this event
Returns:
string value of event's data

setEventData1

public void setEventData1(java.lang.String eventData1)
Sets the event data of this event to the specified value. This value cannot be modified for system-defined events
Parameters:
eventData1 - - event data to be assigned to this event

getEventData2

public java.lang.String getEventData2()
Retrieves the data for this event
Returns:
string value of event's data

setEventData2

public void setEventData2(java.lang.String eventData2)
Sets the event data of this event to the specified value. This value cannot be modified for system-defined events
Parameters:
eventData2 - - event data to be assigned to this event

getEventData3

public java.lang.String getEventData3()
Retrieves the data for this event
Returns:
string value of event's data

setEventData3

public void setEventData3(java.lang.String eventData3)
Sets the event data of this event to the specified value. This value cannot be modified for system-defined events
Parameters:
eventData3 - - event data to be assigned to this event

getEventData4

public java.lang.String getEventData4()
Retrieves the data for this event
Returns:
string value of event's data

setEventData4

public void setEventData4(java.lang.String eventData4)
Sets the event data of this event to the specified value. This value cannot be modified for system-defined events
Parameters:
eventData4 - - event data to be assigned to this event

getEventData5

public java.lang.String getEventData5()
Retrieves the data for this event
Returns:
string value of event's data

setEventData5

public void setEventData5(java.lang.String eventData5)
Sets the event data of this event to the specified value. This value cannot be modified for system-defined events
Parameters:
eventData5 - - event data to be assigned to this event

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.