1 package FS::clientapi_session;
5 use FS::Record qw( qsearch qsearchs );
11 FS::clientapi_session - Object methods for clientapi_session records
15 use FS::clientapi_session;
17 $record = new FS::clientapi_session \%hash;
18 $record = new FS::clientapi_session { 'column' => 'value' };
20 $error = $record->insert;
22 $error = $new_record->replace($old_record);
24 $error = $record->delete;
26 $error = $record->check;
30 An FS::clientapi_session object represents an FS::ClientAPI session.
31 FS::clientapi_session inherits from FS::Record. The following fields are
36 =item sessionnum - primary key
38 =item sessionid - session ID
40 =item namespace - session namespace
50 Creates a new record. To add the record to the database, see L<"insert">.
52 Note that this stores the hash reference, not a distinct copy of the hash it
53 points to. You can ask the object for a copy with the I<hash> method.
57 # the new method can be inherited from FS::Record, if a table method is defined
59 sub table { 'clientapi_session'; }
63 Adds this record to the database. If there is an error, returns the error,
64 otherwise returns false.
68 # the insert method can be inherited from FS::Record
72 Delete this record from the database.
76 # the delete method can be inherited from FS::Record
78 =item replace OLD_RECORD
80 Replaces the OLD_RECORD with this one in the database. If there is an error,
81 returns the error, otherwise returns false.
85 # the replace method can be inherited from FS::Record
89 Checks all fields to make sure this is a valid record. If there is
90 an error, returns the error, otherwise returns false. Called by the insert
95 # the check method should currently be supplied - FS::Record contains some
96 # data checking routines
102 $self->ut_numbern('primary_key')
103 || $self->ut_number('validate_other_fields')
105 return $error if $error;
116 L<FS::ClientAPI>, <FS::Record>, schema.html from the base documentation.