add services as per customer, RT#7083
[freeside.git] / FS / FS / clientapi_session_field.pm
1 package FS::clientapi_session_field;
2
3 use strict;
4 use vars qw( @ISA );
5 use FS::Record qw( qsearch qsearchs );
6
7 @ISA = qw(FS::Record);
8
9 =head1 NAME
10
11 FS::clientapi_session_field - Object methods for clientapi_session_field records
12
13 =head1 SYNOPSIS
14
15   use FS::clientapi_session_field;
16
17   $record = new FS::clientapi_session_field \%hash;
18   $record = new FS::clientapi_session_field { 'column' => 'value' };
19
20   $error = $record->insert;
21
22   $error = $new_record->replace($old_record);
23
24   $error = $record->delete;
25
26   $error = $record->check;
27
28 =head1 DESCRIPTION
29
30 An FS::clientapi_session_field object represents a FS::ClientAPI session data
31 field.  FS::clientapi_session_field inherits from FS::Record.  The following
32 fields are currently supported:
33
34 =over 4
35
36 =item fieldnum - primary key
37
38 =item sessionnum - Base ClientAPI sesison (see L<FS::clientapi_session>)
39
40 =item fieldname
41
42 =item fieldvalie
43
44 =back
45
46 =head1 METHODS
47
48 =over 4
49
50 =item new HASHREF
51
52 Creates a new record.  To add the record to the database, see L<"insert">.
53
54 Note that this stores the hash reference, not a distinct copy of the hash it
55 points to.  You can ask the object for a copy with the I<hash> method.
56
57 =cut
58
59 # the new method can be inherited from FS::Record, if a table method is defined
60
61 sub table { 'clientapi_session_field'; }
62
63 =item insert
64
65 Adds this record to the database.  If there is an error, returns the error,
66 otherwise returns false.
67
68 =cut
69
70 # the insert method can be inherited from FS::Record
71
72 =item delete
73
74 Delete this record from the database.
75
76 =cut
77
78 # the delete method can be inherited from FS::Record
79
80 =item replace OLD_RECORD
81
82 Replaces the OLD_RECORD with this one in the database.  If there is an error,
83 returns the error, otherwise returns false.
84
85 =cut
86
87 # the replace method can be inherited from FS::Record
88
89 =item check
90
91 Checks all fields to make sure this is a valid record.  If there is
92 an error, returns the error, otherwise returns false.  Called by the insert
93 and replace methods.
94
95 =cut
96
97 # the check method should currently be supplied - FS::Record contains some
98 # data checking routines
99
100 sub check {
101   my $self = shift;
102
103   my $error = 
104     $self->ut_numbern('primary_key')
105     || $self->ut_number('validate_other_fields')
106   ;
107   return $error if $error;
108
109   $self->SUPER::check;
110 }
111
112 =back
113
114 =head1 BUGS
115
116 =head1 SEE ALSO
117
118 L<FS::clientapi_session>, L<FS::ClientAPI>, L<FS::Record>, schema.html from the
119 base documentation.
120
121 =cut
122
123 1;
124