• NAME
• SYNOPSIS
• DESCRIPTION
• BASIC METHODS
  • new
  • update
• CONTENT METHODS
  • ClientID
  • ContactID
  • Created
  • Description
  • DoneOn
  • EmployeeID
  • InvoiceID
  • InvoiceTypeID
  • ItemID
  • LeaderID
  • OrderID
  • OrderedByID
  • ParentInvoiceTypeID
  • ParentTariffID
  • ParentWorkTimeID
  • ParentWorkTypeID
  • ProjectID
  • Status
  • TariffID
  • TimeSpent
  • TravelDistance
  • TravelTime
  • Updated
  • URL
  • URLID
  • WorkTimeID
  • WorkTypeID
• AUTHOR
• COPYRIGHT
• HISTORY

NAME

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

SYNOPSIS

 use xxLINK;
 $xxlink = new xxLINK;
 $projectset = $xxlink->ProjectSet;
 
 $done = $projectset->Done;
 $done = $projectset->Done( $doneID );

 $doneID = $done->update;

DESCRIPTION

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

BASIC METHODS

new

Create a new Done object from a client module object.

Input Parameters

 1 Liz::SQL object
 2 ID to create Done object with
 3 todoID/itemID/Description to create Done 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;
 $done = $projectset->Done;
 $done = $projectset->Done( $doneID );

update

Update a Done object in the database.

Output Parameters

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

Example

 $done->update;

CONTENT METHODS

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

ClientID

Return the ClientID of the Liz::ProjectSet::Done object. Its value can be used to create a new Liz::ProjectSet::Client object.

Output Parameters

 1 value of ContactID

Example

 $clientID = $done->ClientID;

ContactID

Return or set the ContactID (of the client's contact of the project when this work was done) of the Liz::ProjectSet::Done object. Its value can be used to create a new Liz::ProjectSet::Contact object.

Input Parameters

 1 new value of ContactID
   (default: no change)

Output Parameters

 1 current/old value of ContactID

Example

 $done->ContactID( $contactID );
 $contactID = $done->ContactID;

Created

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

Output Parameters

 1 current timestamp of the Created

Example

 $created = $done->Created;

Description

Return or set the Description (of the work done) of the Liz::ProjectSet::Done object.

Input Parameters

 1 new contents of Description
   (default: no change)

Output Parameters

 1 current/old contents of Description

Example

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

DoneOn

Return or set the DoneOn information (the timestamp of the date when the work was performed) of the Liz::ProjectSet::Done object.

Input Parameters

 1 new value of DoneOn (timestamp)
   (default: no change)

Output Parameters

 1 current/old value of DoneOn

Example

 $done->DoneOn( $done->Int2Timestamp( $year,$month,$day );
 $doneon = $done->Timestamp2Date( '',$done->DoneOn );

EmployeeID

Return or set the EmployeeID information (employeeID of the person who has done the work) of the Liz::ProjectSet::Done object.

Input Parameters

 1 new value of EmployeeID
   (default: no change)

Output Parameters

 1 current/old value of EmployeeID

Example

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

InvoiceID

Return or set the InvoiceID information (the ID of the invoice on which this work was charged) of the Liz::ProjectSet::Done object.

Input Parameters

 1 new value of InvoiceID
   (default: no change)

Output Parameters

 1 current/old value of InvoiceID

Example

 $done->InvoiceID( $invoiceID );
 $invoiceID = $done->InvoiceID;

InvoiceTypeID

Return or set the InvoiceTypeID information (the categoryID for the type of invoicing to be performed) of the Liz::ProjectSet::Done object. Use method ParentInvoiceTypeID for the categoryID of the parent category of all InvoiceTypes, which can be used to e.g. create a pulldown.

Input Parameters

 1 new value of InvoiceTypeID
   (default: no change)

Output Parameters

 1 current/old value of InvoiceTypeID

Example

 $done->InvoiceTypeID( $invoicetypeID );
 $invoicetypeID = $done->InvoiceTypeID;

ItemID

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

Input Parameters

 1 new value of ItemID
   (default: no change)

Output Parameters

 1 current/old value of ItemID

Example

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

LeaderID

Return or set the LeaderID information (employeeID of the person leading the project) of the Liz::ProjectSet::Done object.

Input Parameters

 1 new value of LeaderID
   (default: no change)

Output Parameters

 1 current/old value of LeaderID

Example

 $done->LeaderID( $leaderID );
 $leaderID = $done->LeaderID;

OrderID

Return the OrderID (of the order for which this work was done) of the Liz::ProjectSet::Done object. Its value can be used to create a new Liz::ProjectSet::Order object.

Output Parameters

 1 value of OrderID

Example

 $orderID = $done->OrderID;

OrderedByID

Return or set the OrderedByID information (contactID or employeeID of the person ordering to do the work) of the Liz::ProjectSet::Done object.

Input Parameters

 1 new value of OrderedByID
   (default: no change)

Output Parameters

 1 current/old value of OrderedByID

Example

 $done->OrderedByID( $orderedbyID );
 $orderedbyID = $done->OrderedByID;

ParentInvoiceTypeID

Return the ParentInvoiceTypeID (the categoryID of the parent of all possible InvoiceTypes) which can be used to e.g. create a pulldown. Use method InvoiceTypeID to actually set the type of invoice for this object.

Output Parameters

 1 current value of ParentInvoiceTypeID

Example

 $parentinvoicetypeID = $done->ParentInvoiceTypeID;

ParentTariffID

Return the ParentTariffID (the categoryID of the parent of all possible Tariffs) which can be used to e.g. create a pulldown. Use method TariffID to actually set the type of tariff for this object.

Output Parameters

 1 current value of ParentTariffID

Example

 $parenttariffID = $done->ParentTariffID;

ParentWorkTimeID

Return the ParentWorkTimeID (the categoryID of the parent of all possible WorkTimes) which can be used to e.g. create a pulldown. Use method WorkTimeID to actually set the type of worktime for this object.

Output Parameters

 1 current value of ParentWorkTimeID

Example

 $parentworktimeID = $done->ParentWorkTimeID;

ParentWorkTypeID

Return the ParentWorkTypeID (the categoryID of the parent of all possible WorkTypes) which can be used to e.g. create a pulldown. Use method WorkTypeID to actually set the type of work for this object.

Output Parameters

 1 current value of ParentWorkTypeID

Example

 $parentworktypeID = $done->ParentWorkTypeID;

ProjectID

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

Output Parameters

 1 value of ProjectID

Example

 $projectID = $done->ProjectID;

Status

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

Input Parameters

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

Output Parameters

 1 current/old value of the Status

Example

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

TariffID

Return or set the TariffID information (the categoryID for the tariff to be invoiced) of the Liz::ProjectSet::Done object. Use method ParentTariffID for the categoryID of the parent category of all Tariffes, which can be used to e.g. create a pulldown.

Input Parameters

 1 new value of TariffID
   (default: no change)

Output Parameters

 1 current/old value of TariffID

Example

 $done->TariffID( $tariffID );
 $tariffID = $done->TariffID;

TimeSpent

Return or set the TimeSpent info (number of minutes of work spent on this record) of the Liz::ProjectSet::Done object.

Input Parameters

 1 new value of TimeSpent
   (default: no change)

Output Parameters

 1 current/old value of TimeSpent

Example

 $done->TimeSpent( 30 );
 $timespent = $done->TimeSpent;

TravelDistance

Return or set the TravelDistance info (number of kilometers travelled on this record) of the Liz::ProjectSet::Done object.

Input Parameters

 1 new value of TravelDistance
   (default: no change)

Output Parameters

 1 current/old value of TravelDistance

Example

 $done->TravelDistance( 2*50 );
 $traveltime = $done->TravelDistance;

TravelTime

Return or set the TravelTime info (number of minutes of work spent travelling on this record) of the Liz::ProjectSet::Done object.

Input Parameters

 1 new value of TravelTime
   (default: no change)

Output Parameters

 1 current/old value of TravelTime

Example

 $done->TravelTime( 30 );
 $traveltime = $done->TravelTime;

Updated

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

Output Parameters

 1 current timestamp of the Updated

Example

 $updated = $done->Updated;

URL

Specify or return the URL associated with the Done object.

Input Parameters

 1 new value of the URL
   (default: no change)

Output Parameters

 1 previous/current version of the URL

Example

 $done->URL( $url );
 $url = $done->URL;

URLID

Specify or return the URLID associated with the Liz::ProjectSet::Done object.

Input Parameters

 1 new value of the URLID
   (default: no change)

Output Parameters

 1 previous/current version of the URLID

Example

 $done->URLID( $urlID );
 $urlID = $done->URLID;

WorkTimeID

Return or set the WorkTimeID information (the categoryID for the sort of time of work performed) of the Liz::ProjectSet::Done object. Use method ParentWorkTimeID for the categoryID of the parent category of all WorkTimes, which can be used to e.g. create a pulldown.

Input Parameters

 1 new value of WorkTimeID
   (default: no change)

Output Parameters

 1 current/old value of WorkTimeID

Example

 $done->WorkTimeID( $worktimeID );
 $worktimeID = $done->WorkTimeID;

WorkTypeID

Return or set the WorkTypeID information (the categoryID for the type of work performed) of the Liz::ProjectSet::Done object. Use method ParentWorkTypeID for the categoryID of the parent category of all WorkTypes, which can be used to e.g. create a pulldown.

Input Parameters

 1 new value of WorkTypeID
   (default: no change)

Output Parameters

 1 current/old value of WorkTypeID

Example

 $done->WorkTypeID( $worktypeID );
 $worktypeID = $done->WorkTypeID;

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, 24 November 1999

Fixed case-problem with key in OrderID.

Version 0.12, 30 September 1999

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

Version 0.11, 13 September 1999

Support for extra fields added.

Version 0.1, 14 August 1999

First version of this true Perl module.