1 package FS::clientapi_session;
2 use base qw(FS::Record);
8 FS::clientapi_session - Object methods for clientapi_session records
12 use FS::clientapi_session;
14 $record = new FS::clientapi_session \%hash;
15 $record = new FS::clientapi_session { 'column' => 'value' };
17 $error = $record->insert;
19 $error = $new_record->replace($old_record);
21 $error = $record->delete;
23 $error = $record->check;
27 An FS::clientapi_session object represents an FS::ClientAPI session.
28 FS::clientapi_session inherits from FS::Record. The following fields are
33 =item sessionnum - primary key
35 =item sessionid - session ID
37 =item namespace - session namespace
47 Creates a new record. To add the record to the database, see L<"insert">.
49 Note that this stores the hash reference, not a distinct copy of the hash it
50 points to. You can ask the object for a copy with the I<hash> method.
54 # the new method can be inherited from FS::Record, if a table method is defined
56 sub table { 'clientapi_session'; }
60 Adds this record to the database. If there is an error, returns the error,
61 otherwise returns false.
65 # the insert method can be inherited from FS::Record
69 Delete this record from the database.
73 # the delete method can be inherited from FS::Record
75 =item replace OLD_RECORD
77 Replaces the OLD_RECORD with this one in the database. If there is an error,
78 returns the error, otherwise returns false.
82 # the replace method can be inherited from FS::Record
86 Checks all fields to make sure this is a valid record. If there is
87 an error, returns the error, otherwise returns false. Called by the insert
92 # the check method should currently be supplied - FS::Record contains some
93 # data checking routines
99 $self->ut_numbern('primary_key')
100 || $self->ut_number('validate_other_fields')
102 return $error if $error;
113 L<FS::ClientAPI>, <FS::Record>, schema.html from the base documentation.