FS/FS/clientapi_session.pm

   1 package FS::clientapi_session;
   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 - Object methods for clientapi_session records
  12
  13 =head1 SYNOPSIS
  14
  15   use FS::clientapi_session;
  16
  17   $record = new FS::clientapi_session \%hash;
  18   $record = new FS::clientapi_session { '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 object represents an FS::ClientAPI session.
  31 FS::clientapi_session inherits from FS::Record.  The following fields are
  32 currently supported:
  33
  34 =over 4
  35
  36 =item sessionnum - primary key
  37
  38 =item sessionid - session ID
  39
  40 =item namespace - session namespace
  41
  42 =back
  43
  44 =head1 METHODS
  45
  46 =over 4
  47
  48 =item new HASHREF
  49
  50 Creates a new record.  To add the record to the database, see L<"insert">.
  51
  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.
  54
  55 =cut
  56
  57 # the new method can be inherited from FS::Record, if a table method is defined
  58
  59 sub table { 'clientapi_session'; }
  60
  61 =item insert
  62
  63 Adds this record to the database.  If there is an error, returns the error,
  64 otherwise returns false.
  65
  66 =cut
  67
  68 # the insert method can be inherited from FS::Record
  69
  70 =item delete
  71
  72 Delete this record from the database.
  73
  74 =cut
  75
  76 # the delete method can be inherited from FS::Record
  77
  78 =item replace OLD_RECORD
  79
  80 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  81 returns the error, otherwise returns false.
  82
  83 =cut
  84
  85 # the replace method can be inherited from FS::Record
  86
  87 =item check
  88
  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
  91 and replace methods.
  92
  93 =cut
  94
  95 # the check method should currently be supplied - FS::Record contains some
  96 # data checking routines
  97
  98 sub check {
  99   my $self = shift;
 100
 101   my $error =
 102     $self->ut_numbern('primary_key')
 103     || $self->ut_number('validate_other_fields')
 104   ;
 105   return $error if $error;
 106
 107   $self->SUPER::check;
 108 }
 109
 110 =back
 111
 112 =head1 BUGS
 113
 114 =head1 SEE ALSO
 115
 116 L<FS::ClientAPI>, <FS::Record>, schema.html from the base documentation.
 117
 118 =cut
 119
 120 1;
 121