NAME

Liz::ProjectSet::Order - Order objects within the ProjectSet


SYNOPSIS

 use xxLINK;
 $xxlink = new xxLINK;
 $projectset = $xxlink->ProjectSet;
 $project = $projectset->Project( $projectID );
 $order = $project->Order;


DESCRIPTION

Provide object oriented access to the Order tables of the ProjectSet. The Liz::ProjectSet::Order object is in fact a Liz::Forum::Message object in disguise. See the documentation of that module for more information.


BASIC METHODS


new

Create a new Order object from a ProjectSet object.

Input Parameters

 1 ProjectSet object
 2 ID or name to create Order object with
   (default: none = new order)
 3 projectID for which this order should be created
Output Parameters

 1 instantiated object
Note

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

Example

 $xxlink = new xxLINK;
 $projectset = $xxlink->ProjectSet;
 $order = $projectset->Order;
 $order = $projectset->Order( $orderID,$projectID );


update

Update the Order object.

Output Parameters

 1 the ID of the Order object
Example

 $orderID = $order->update;


CONTENT METHODS

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


ClientID

Return the ClientID of the Order.

Output Parameters

 1 clientID of the project of the Order
Example

 $clientID = $order->ClientID;


Created

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

Output Parameters

 1 current timestamp of the Created
Example

 $created = $order->Created;


Deadline

Set or return the timestamp of the deadline of the Order.

Input Parameters

 1 new deadline of the Order
   (default: no change)
Output Parameters

 1 current/old deadline of the Order
Example

 $order->Deadline( $deadline );
 $deadline = $order->Deadline;


Description

Set or return the description of the Order.

Input Parameters

 1 new description of the Order
   (default: no change)
Output Parameters

 1 current/old description of the Order
Example

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


EmployeeIDs

Return or set the EmployeeIDs (list of contactID's from the EmployeeSet) of the Liz::ProjectSet::Order object.

Input Parameters

 1..N new employeeID's
      (default: no change)
Output Parameters

 1..N current/old employeeID's
Example

 $client->EmployeeIDs( @employeeID );
 @employeeID = $client->EmployeeIDs;


ForeignKey

Set or return the foreign key of the Order. This is usually the offerID or the contract ID of the customer's system.

Input Parameters

 1 new foreign key of the Order
   (default: no change)
Output Parameters

 1 current/old foreign key of the Order
Example

 $order->ForeignKey( $foreignkey );
 $foreignkey = $order->ForeignKey;


History

Set or return the history of the Order.

Input Parameters

 1 new history of the Order
   (default: no change)
Output Parameters

 1 current/old history of the Order
Example

 $order->History( $history );
 $history = $order->History;


InvoiceContactID

Return or set the InvoiceContactID of the Liz::ProjectSet::Order object.

Input Parameters

 1 new InvoiceContactID
   (default: no change)
Output Parameters

 1 current/old InvoiceContactID
Example

 $client->InvoiceContactID( $invoicecontactID );
 $invoicecontactID = $client->InvoiceContactID;


LeaderID

Set or return the leaderID of the Order.

Input Parameters

 1 new leaderID of the Order
   (default: no change)
Output Parameters

 1 current/old leaderID of the Order
Example

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


Name

Set or return the name of the Order.

Input Parameters

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

 1 current/old name of the Order
Example

 $order->Name( $name );
 $name = $order->Name;


OtherContactIDs

Return or set the OtherContactIDs (list of contactID's) of the Liz::ProjectSet::Order object.

Input Parameters

 1..N new othercontactID's
      (default: no change)
Output Parameters

 1..N current/old othercontactID's
Example

 $client->OtherContactIDs( @othercontactID );
 @othercontactID = $client->OtherContactIDs;


ProjectID

Return or set the projectID of the Order.

Input Parameters

 1 new projectID of the Order
   (default: no change)
Output Parameters

 1 current/old projectID of the Order
Example

 $order->ProjectID( $projectID );
 $projectID = $order->ProjectID;


SortName

Return or set the SortName information of the Liz::ProjectSet::Order object.

Input Parameters

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

 1 current/old value of the SortName
Example

 $order->SortName( $sortname );
 $sortname = $order->SortName;


Status

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

Input Parameters

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

 1 current/old value of the Status
Example

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


Updated

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

Output Parameters

 1 current timestamp of the Updated
Example

 $updated = $order->Updated;


URL

Specify or return the URL associated with the Liz::ProjectSet::Order object.

Input Parameters

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

 1 previous/current version of the URL
Example

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


URLID

Return the URLID of the Liz::ProjectSet::Order object. This is usually only used internally. It is better to use the more transparant method URL instead.

Output Parameters

 1 current urlID
Example

 $urlID = $project->URLID;


LIST METHODS

The following methods return an SQL-statement(-like) handle that allows listing of (a selection of) the objects of a certain type.


Items

Return an SQL-statement(-like) handle that contains a selection of the Items available in the ProjectSet. The following field names can be specified with the first parameter:

 ID
 The ID of the Item.  Can be used as parameter on the L<Item>
 method.

 description
 The description of the Item, e.g. 'Implementatie MailingList Functionaliteit'.

 deadline
 Timestamp for the deadline of the Item

 status
 The status of the Item: this can be any number between 0 and 255 inclusive.

 orderedbyID
 The ID of the Contact/Employee information of the Item

 updated
 Timestamp when the Item record was last updated in the database.

 created
 Timestamp when the Item record was created in the database.

 orderID
 The ID of the Order information of the Item.  If non-zero, can be
 used to create an L<Order> object with.

 contactID
 The ID of the Contact information of the Item.  If non-zero, can be
 used to create an L<Contact> object with.

 urlID
 The ID of the URL associated with the Item.  If non-zero, can be
 used to create an L<URL> object with.

 invoicetypeID
 The ID of the category that contains the type of invoicing to be
 performed.

 worktypeID
 The ID of the category that contains the type of work to be done.

 tariffID
 The ID of the category that contains the tariff to be used for invoicing.
Input Parameters

 1 fields to return for each Item, seperated by comma's
   (default: 'ID,description,deadline,status,orderedbyID,updated,created,orderID,contactID,urlID,invoicetypeID,worktypeID,tariffID' );
 2 extra SQL condition to apply
   (default: none)
 3 order in which to return the finds
   (default: sortname)
 4 which records should be returned
   (default: all )
Output Parameters

 1 SQL-like statement handle (on which method "fetchrow" can be applied)
Examples

 $result = $projectset->Items;
 $result = $projectset->Items( 'ID,description,orderedbyID','status=0' );


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

Added OrganizationID to the allowed list.

Version 0.12, 30 September 1999

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

Version 0.11, 20 August 1999

Added support for extra fields to methods new and update.

Version 0.1, 14 August 1999

First version of this true Perl module.