Difference between revisions of "Freeside:3:Documentation:Developer/FS/sched item"
From Freeside
(Edit via perl MediaWiki framework (1.13)) |
m (Edit via perl MediaWiki framework (1.13)) |
||
| Line 41: | Line 41: | ||
: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. | :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 | ; name | ||
| − | :Returns a name for this item; either the name of the associated employee (see [[ | + | :Returns a name for this item; either the name of the associated employee (see [[Freeside:3:Documentation:Developer/FS/access user|FS::access_user]]), or the itemname field. |
; replace_sched_avail SCHED_AVAIL, ... | ; replace_sched_avail SCHED_AVAIL, ... | ||
:Replaces the existing availability schedule with the list of passed-in FS::sched_avail objects | :Replaces the existing availability schedule with the list of passed-in FS::sched_avail objects | ||
| Line 48: | Line 48: | ||
==SEE ALSO== | ==SEE ALSO== | ||
[[Freeside:3:Documentation:Developer/FS/access user|FS::access_user]], [[Freeside:3:Documentation:Developer/FS/sched avail|FS::sched_avail]], [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]] | [[Freeside:3:Documentation:Developer/FS/access user|FS::access_user]], [[Freeside:3:Documentation:Developer/FS/sched avail|FS::sched_avail]], [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 06:40, 10 February 2015
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
