FS/FS/access_groupagent.pm

   1 package FS::access_groupagent;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use FS::Record qw( qsearch qsearchs );
   6 use FS::agent;
   7 use FS::access_group;
   8
   9 @ISA = qw(FS::Record);
  10
  11 =head1 NAME
  12
  13 FS::access_groupagent - Object methods for access_groupagent records
  14
  15 =head1 SYNOPSIS
  16
  17   use FS::access_groupagent;
  18
  19   $record = new FS::access_groupagent \%hash;
  20   $record = new FS::access_groupagent { 'column' => 'value' };
  21
  22   $error = $record->insert;
  23
  24   $error = $new_record->replace($old_record);
  25
  26   $error = $record->delete;
  27
  28   $error = $record->check;
  29
  30 =head1 DESCRIPTION
  31
  32 An FS::access_groupagent object represents an group reseller virtualization.  FS::access_groupagent inherits from
  33 FS::Record.  The following fields are currently supported:
  34
  35 =over 4
  36
  37 =item groupagentnum - primary key
  38
  39 =item groupnum -
  40
  41 =item agentnum -
  42
  43
  44 =back
  45
  46 =head1 METHODS
  47
  48 =over 4
  49
  50 =item new HASHREF
  51
  52 Creates a new group reseller virtualization.  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 { 'access_groupagent'; }
  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 group reseller virtualization.  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('groupagentnum')
 105     || $self->ut_foreign_key('groupnum', 'access_group', 'groupnum')
 106     || $self->ut_foreign_key('agentnum', 'agent',        'agentnum')
 107   ;
 108   return $error if $error;
 109
 110   $self->SUPER::check;
 111 }
 112
 113 =item agent
 114
 115 Returns the associated FS::agent object.
 116
 117 =cut
 118
 119 sub agent {
 120   my $self = shift;
 121   qsearchs('agent', { 'agentnum' => $self->agentnum } );
 122 }
 123
 124 =item access_group
 125
 126 Returns the associated FS::access_group object.
 127
 128 =cut
 129
 130 sub access_group {
 131   my $self = shift;
 132   qsearchs('access_group', { 'groupnum' => $self->groupnum } );
 133 }
 134
 135 =back
 136
 137 =head1 BUGS
 138
 139 =head1 SEE ALSO
 140
 141 L<FS::Record>, schema.html from the base documentation.
 142
 143 =cut
 144
 145 1;
 146