Difference between revisions of "Freeside:4:Documentation:Developer/FS/prospect main"

Latest revision as of 07:27, 18 November 2015

NAME

FS::prospect_main - Object methods for prospect_main records

SYNOPSIS

 use FS::prospect_main;

 $record = new FS::prospect_main \%hash;
 $record = new FS::prospect_main { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::prospect_main object represents a prospect. FS::prospect_main inherits from FS::Record. The following fields are currently supported:

prospectnum

primary key

agentnum

Agent (see FS::agent)

refnum

Referral (see FS::part_referral)

company

company

METHODS

new HASHREF

Creates a new prospect. To add the prospect to the database, see "insert".

Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.

insert

Adds this record to the database. If there is an error, returns the error, otherwise returns false.

delete

Delete this record from the database.

replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.

check

Checks all fields to make sure this is a valid prospect. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

name

Returns a name for this prospect, as a string (company name for commercial prospects, contact name for residential prospects).

contact

Returns the contacts (see FS::contact) associated with this prospect.

cust_location

Returns the locations (see FS::cust_location) associated with this prospect.

qual

Returns the qualifications (see FS::qual) associated with this prospect.

agent

Returns the agent (see FS::agent) for this customer.

tax_status

Returns the external tax status, as an FS::tax_status object, or the empty string if there is no tax status.

taxstatus

Returns the tax status code if there is one.

convert_cust_main

Converts this prospect to a customer.

If there is an error, returns an error message, otherwise, returns the newly-created FS::cust_main object.

search HASHREF

(Class method)

Returns a qsearch hash expression to search for the parameters specified in HASHREF. Valid parameters are:

agentnum

BUGS

SEE ALSO

FS::Record, schema.html from the base documentation.