NAME

Liz::EventSet::Event - module for Event objects of the EventSet


SYNOPSIS

 use Liz::EventSet;
 $eventset = new Liz::EventSet;

 $event = $eventset->Event;
 $event = $eventset->Event( $eventID );

 $event->update;


EXAMPLES


DESCRIPTION

Provide object oriented access to events in a EventSet. Usually not accessed directly, but rather through the Liz::EventSet object and its Event method.


BASIC METHODS


new

Create a new Event object from a EventSet object.

Input Parameters

 1 Liz::EventSet object
 2 ID to created Event object with
   (default: none = new event)
Output Parameters

 1 instantiated object
Note

It is not intended to call this method directly, but rather indirectly through the Liz::EventSet module.

Example

 $eventset = new Liz::EventSet;
 $event = $eventset->Event;
 $event = $eventset->Event( $eventID );


update

Update a Event object in the Liz::EventSet database.

Output Parameters

 1 ID with which the object was updated (undef = error)
Example

 $eventID = $event->update;


delete

Delete a Liz::EventSet::Event object from the database.

Output Parameters

 1 flag: whether action was successful
Example

 $event->delete;


CONTENT METHODS

The following methods allow you to inspect and/or change certain fields of the Liz::EventSet::Event object.


Created

Return the Created timestamp of the Liz::EventSet::Event object.

Output Parameters

 1 current timestamp value of the Created date
Example

 $created = $event->Created;


Description

Return or set the Description of the Liz::EventSet::Event object.

Input Parameters

 1 new description
   (default: no change)
Output Parameters

 1 current/old description
Example

 $event->Description( $description );
 $description = $event->Description;


ID

Return the ID of the Liz::EventSet::Event object.

Output Parameters

 1 current ID of the object
Example

 $ID = $event->ID;


IP

Return the IP-number from where the Liz::EventSet::Event object was created or last changed.

Output Parameters

 1 IP-number from which created or last changed
Example

 $IP = $event->IP;


Options

Return or set the Options information of the Liz::EventSet::Event object.

Input Parameters

 1 new name value of the Options
   (default: no change)
Output Parameters

 1 current/old name value of the Options
Example

 $event->Options( $options );
 $options = $event->Options;


OriginatorID

Return or set the OriginatorID of the Liz::EventSet::Event object.

Input Parameters

 1 new originatorID
   (default: no change)
Output Parameters

 1 current/old originatorID
Example

 $event->OriginatorID( $originatorID );
 $originatorID = $event->OriginatorID;


Status

Return or set the Status information of the Liz::EventSet::Event object.

Input Parameters

 1 new value of the Status
   (default: no change)
Output Parameters

 1 current/old value of the Status
Example

 $event->Status( $status );
 $status = $event->Status;


Updated

Return the Updated timestamp of the Liz::EventSet::Event object.

Output Parameters

 1 current timestamp value of the Updated date
Example

 $updated = $event->Updated;


AUTHOR

Elizabeth Mattijsen ( lizperl@INC.nl )


COPYRIGHT

(C) 1998-1999 International Network Consultants


HISTORY

Version 0.22, 30 September 1999

Now no longer adds Exporter to ISA: it wasn't necessary.

Version 0.21, 20 August 1999

Changed methods new and update so that any extra fields are also correctly handled.

Changed to new source typography.

Version 0.2, 27 April 1999

Fixed problem in method update which would not return the ID of the object if the object was not changed.

Version 0.1, 9 April 1999

First version of this true Perl module. Copied from the Liz::FileSet::File module.