Difference between revisions of "Freeside:3:Documentation:Developer/FS/sched avail"

Latest revision as of 13:39, 27 June 2014

NAME

FS::sched_avail - Object methods for sched_avail records

SYNOPSIS

 use FS::sched_avail;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::sched_avail object represents an availability period/interval. FS::sched_avail inherits from FS::Record. The following fields are currently supported:

availnum

primary key

itemnum

itemnum

wday

wday

stime

stime

etime

etime

override_date

override_date

METHODS

new HASHREF

Creates a new period. To add the period 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 period. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

stime_pretty; etime_pretty

BUGS

SEE ALSO

FS::sched_item, FS::Record