NAME

Liz::ProjectSet::Todo - generic module for Todo objects


SYNOPSIS

 use xxLINK;
 $xxlink = new xxLINK;
 $projectset = $xxlink->ProjectSet;
 
 $todo = $projectset->Todo;
 $todo = $projectset->Todo( $todoID );

 $todoID = $todo->update;


DESCRIPTION

Provide object oriented access to the Todo object of the Liz::ProjectSet module family. Usually not accessed directly, but rather through a client module.


BASIC METHODS


new

Create a new Todo object from a client module object.

Input Parameters

 1 Liz::SQL object
 2 ID/Description to create Todo object with
 3 itemID to create Todo Object with
Output Parameters

 1 instantiated object
Note

It is not intended to call this method directly, but rather indirectly through a client module.

Example

 $xxlink = new xxLINK;
 $projectset = $xxlink->ProjectSet;
 $todo = $projectset->Todo;
 $todo = $projectset->Todo( $todoID );


update

Update a Todo object in the database.

Output Parameters

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

 $todo->update;


CONTENT METHODS

The following methods allow you to change the fields associated with the Liz::ProjectSet::Todo object.


ClientID

Return the ClientID (of the client for which this work was todo) of the Liz::ProjectSet::Todo object. Its value can be used to create a new Liz::ProjectSet::Client object.

Output Parameters

 1 current value of clientID
Example

 $clientID = $todo->ClientID;


ContactID

Return the ContactID (of the client for which this work was todo) of the Liz::ProjectSet::Todo object. Its value can be used to create a new Liz::ProjectSet::Contact object.

Output Parameters

 1 current value of contactID
Example

 $contactID = $todo->ContactID;


Created

Return the Created information of the Liz::ProjectSet::Todo object.

Output Parameters

 1 current timestamp of the Created
Example

 $created = $todo->Created;


Deadline

Return or set the Deadline information (the timestamp of the date when the work should be finished) of the Liz::ProjectSet::Todo object.

Input Parameters

 1 new value of Deadline (timestamp)
   (default: no change)
Output Parameters

 1 current/old value of Deadline
Example

 $todo->Deadline( $todo->Int2Timestamp( $year,$month,$day );
 $todoon = $todo->Timestamp2Date( '',$todo->Deadline );


Description

Return or set the Description (of the work todo) of the Liz::ProjectSet::Todo object.

Input Parameters

 1 new contents of Description
   (default: no change)
Output Parameters

 1 current/old contents of Description
Example

 $todo->Description( 'Implementatie van Liz::ProjectSet' );
 $description = $todo->Description;


DoneID

Return or set the DoneID (of the Done record for which this work was todo) of the Liz::ProjectSet::Todo object. Its value can be used to create a new Liz::ProjectSet::Done object.

Input Parameters

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

 1 current/old value of DoneID
Example

 $todo->DoneID( $doneID );
 $doneID = $todo->DoneID;


EmployeeID

Return or set the EmployeeID information (employeeID of the person or group who has todo the work) of the Liz::ProjectSet::Todo object.

Input Parameters

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

 1 current/old value of EmployeeID
Example

 $todo->EmployeeID( $employeeID );
 $employeeID = $todo->EmployeeID;


ItemID

Return or set the ItemID information (the ID of the Liz::Projectset::Order:Item object to which this work applies) of the Liz::ProjectSet::Todo object.

Input Parameters

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

 1 current/old value of ItemID
Example

 $todo->ItemID( $itemID );
 $itemID = $todo->ItemID;


OrderID

Return the orderID information (the ID of the Liz::Projectset::Order object to which this work applies) of the Liz::ProjectSet::Todo object.

Output Parameters

 1 current value of OrderID
Example

 $orderID = $todo->OrderID;


ProjectID

Return the ProjectID (of the project for which this work was todo) of the Liz::ProjectSet::Todo object. Its value can be used to create a new Liz::ProjectSet::Project object.

Output Parameters

 1 current value of ProjectID
Example

 $projectID = $todo->ProjectID;


Status

Return or set the Status information of the Liz::ProjectSet::Todo object.

Input Parameters

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

 1 current/old value of the Status
Example

 $todo->Status( 1 );
 $status = $todo->Status;


TimeToSpend

Return or set the TimeToSpend info (number of minutes of work expected to be spent on this record) of the Liz::ProjectSet::Todo object.

Input Parameters

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

 1 current/old value of TimeToSpend
Example

 $todo->TimeToSpend( 30 );
 $timetospend = $todo->TimeToSpend;


TodoOn

Return or set the TodoOn information (the timestamp of the date when the work should be done) of the Liz::ProjectSet::Todo object.

Input Parameters

 1 new value of TodoOn (timestamp)
   (default: no change)
Output Parameters

 1 current/old value of TodoOn
Example

 $todo->TodoOn( $todo->Int2Timestamp( $year,$month,$day );
 $todoon = $todo->Timestamp2Date( '',$todo->TodoOn );


Updated

Return the Updated information of the Liz::ProjectSet::Todo object.

Output Parameters

 1 current timestamp of the Updated
Example

 $updated = $todo->Updated;


AUTHOR

Elizabeth Mattijsen ( lizperl@INC.nl )


COPYRIGHT

(C) 1998-1999 International Network Consultants


HISTORY

Version 0.15, 30 November 1999

Now, update sets the alteredbyID-field to the current user ID. Now inherits the PROJECTSET from the object.

Version 0.14, 29 November 1999

Added stuff for alteredbyID-field.

Version 0.13, 30 September 1999

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

Version 0.12, 13 September 1999

Fixed problem in new introduced on August 20th.

Version 0.11, 20 August 1999

Updated methods new and update to support extra fields.

Version 0.1, 14 August 1999

First version of this true Perl module.