Index

DKEventDefICM

Purpose:

The DKEventDefICM class defines methods for accessing event-related information. It contains records related to CRUD (create, retrieve, update and delete) operations on items.

Events logged by the server depend on the item event flag, which is defined in the item type class. Events related to the actions of library server users when working on items can also be logged. After the data for an event is created, it cannot be updated. See Also: DKEventTypeDefICM, DKEventMgmtICM

Since: Version 8

Class summary:

class DKEXPORT DKEventDefICM 
{
 public:
                        DKEventDefICM(dkDatastore* ds);
                        ~DKEventDefICM();
        DKTimestamp*    createTimestamp();
        DKString        userId();
        long            getCode();
        void            setCode( long eventCode );
        long            getEventDataCount();
        void            setEventDataCount( long eventDataCount );
        DKString        getItemId();
        void            setItemId(const char* itemId );
        DKString        getEventData1();
        void            setEventData1( const char* eventData1 );
        DKString        getEventData2();
        void            setEventData2(const char* eventData2 );
        DKString        getEventData3();
        void            setEventData3( const char* eventData3 );
        DKString        getEventData4();
        void            setEventData4( const char* eventData4 );
        DKString        getEventData5();
        void            setEventData5( const char* eventData5 );    
 };

Members:

Constructors and destructor
DKEventDefICM(dkDatastore* ds)

Constructs the definition of an event for the specified ICM datastore.

Parameters:ds - datastore object as an instance of DKDatastoreICM Destructor

virtual~DKEventDefICM()

Destructor for this object.

Member functions

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.

DKTimestamp*    createTimestamp();

userId
Retrieves the identifer for the user who created the event.

Returns:user Identifier as a string variable.

DKString userId();

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 valueint value

long getCode();

setCode
Sets the value for the event code associated with this eventevent code value Please see the description of the getCode method for details on what the event code is and what values are permissible for it.

Parameters:eventCode - event code value to be assigned to this event

void setCode( long eventCode );

getEventDataCount
Retrieves the value of the event data count.

Returns:event data count as an integer value

long getEventDataCount();

setEventDataCount
Sets the value of the event data count.

Parameters:eventDataCount - event data count value to be assigned to this event

void setEventDataCount( long eventDataCount );

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

DKString getItemId();

setItemId
Sets the event's item ID.
void setItemId(const char* itemId);

getEventData1
Retrieves the data for this event.

Returns:string value of event data

DKString getEventData1();

setEventData1
Sets the event data of this event to athe specified value. This value cannot be modified for system-defined events.

Parameters:eventData1 - event data to be assigned to this event

void setEventData1( const char* eventData1 );

getEventData2
Retrieves the data for this events.

Returns:string value of event's data

DKString        getEventData2();

setEventData2
Sets the event data for 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

void setEventData2(const char* eventData2 );

getEventData3
Retrieves the event's data for this event.

Returns:string value of event's data

DKString getEventData3();

setEventData3
Sets the event data for 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

void setEventData3( const char* eventData3 );

getEventData4
Retrieves the data for this event.

Returns:string value of event's data

DKString getEventData4();

setEventData4
Sets the event data for 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

void setEventData4( const char* eventData4 );

getEventData5
Retrieves the data for this event.

Returns:string value of event's data

DKString getEventData5();

setEventData5
Sets the event data for 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

void setEventData5( const char* eventData5 );

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