Freeside:3:Documentation:Developer/FS/sched item
From Freeside
Contents
NAME
FS::sched_item - Object methods for sched_item records
SYNOPSIS
use FS::sched_item;
$record = new FS::sched_item \%hash;
$record = new FS::sched_item { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
DESCRIPTION
An FS::sched_item object represents an schedulable item, such as an installer, meeting room or truck. FS::sched_item inherits from FS::Record. The following fields are currently supported:
- itemnum
- primary key
- usernum
- usernum
- disabled
- disabled
METHODS
- new HASHREF
- Creates a new item. To add the item 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 item. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
- name
- Returns a name for this item; either the name of the associated employee (see FS::access_user), or the itemname field.
- replace_sched_avail SCHED_AVAIL, ...
- Replaces the existing availability schedule with the list of passed-in FS::sched_avail objects
