FS/FS/agent_payment_gateway.pm

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