X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fsched_item.pm;fp=FS%2FFS%2Fsched_item.pm;h=5f55188e61fb1eff8c93c3c9b3d3a8de039cfbb2;hb=0dfd49189b0ea878e99f1590a2939e55ab02c89c;hp=0000000000000000000000000000000000000000;hpb=23699764d0d8436b50f5cf88f798c552969714eb;p=freeside.git diff --git a/FS/FS/sched_item.pm b/FS/FS/sched_item.pm new file mode 100644 index 000000000..5f55188e6 --- /dev/null +++ b/FS/FS/sched_item.pm @@ -0,0 +1,123 @@ +package FS::sched_item; +use base qw( FS::Record ); + +use strict; +#use FS::Record qw( qsearch qsearchs ); + +=head1 NAME + +FS::sched_item - Object methods for sched_item records + +=head1 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; + +=head1 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: + +=over 4 + +=item itemnum + +primary key + +=item usernum + +usernum + +=item disabled + +disabled + + +=back + +=head1 METHODS + +=over 4 + +=item new HASHREF + +Creates a new item. To add the item to the database, see L<"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 I method. + +=cut + +sub table { 'sched_item'; } + +=item insert + +Adds this record to the database. If there is an error, returns the error, +otherwise returns false. + +=item delete + +Delete this record from the database. + +=item replace OLD_RECORD + +Replaces the OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. + +=item 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. + +=cut + +sub check { + my $self = shift; + + my $error = + $self->ut_numbern('itemnum') + || $self->ut_foreign_keyn('usernum', 'access_user', 'usernum') + || $self->ut_enum('disabled', [ '', 'Y' ]) + ; + return $error if $error; + + $self->SUPER::check; +} + +=item name + +Returns a name for this item; either the name of the associated employee (see +Laccess_user; + $access_user ? $access_user->name : $self->itemname; +} + +=back + +=head1 BUGS + +=head1 SEE ALSO + +L, L, L + +=cut + +1; +