Difference between revisions of "Freeside:3:Documentation:Developer/FS/access groupagent"

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
m (Edit via perl MediaWiki framework (1.13))
 
Line 1: Line 1:
 +
==NAME==
 +
FS::access_groupagent - Object methods for access_groupagent records
  
 +
==SYNOPSIS==
 +
<code>
 +
  use FS::access_groupagent;
 +
 +
  $record = new FS::access_groupagent \%hash;
 +
  $record = new FS::access_groupagent { 'column' => 'value' };
 +
 +
  $error = $record->insert;
 +
 +
  $error = $new_record->replace($old_record);
 +
 +
  $error = $record->delete;
 +
 +
  $error = $record->check;
 +
</code>
 +
==DESCRIPTION==
 +
An FS::access_groupagent object represents an group reseller virtualization. FS::access_groupagent inherits from FS::Record. The following fields are currently supported:
 +
 +
; groupagentnum - primary key; groupnum -; agentnum -
 +
==METHODS==
 +
; new HASHREF
 +
:Creates a new group reseller virtualization. To add the record to the database, see [[#insert|"insert"]].
 +
 +
:Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the ''hash'' method.
 +
; insert
 +
:Adds this record to the database. If there is an error, returns the error, otherwise returns false.
 +
; delete
 +
:Delete this record from the database.
 +
; replace OLD_RECORD
 +
:Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
 +
; check
 +
:Checks all fields to make sure this is a valid group reseller virtualization. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
 +
; agent
 +
:Returns the associated FS::agent object.
 +
; access_group
 +
:Returns the associated FS::access_group object.
 +
 +
==BUGS==
 +
==SEE ALSO==
 +
[[Freeside:3:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.

Latest revision as of 05:28, 10 February 2015

NAME

FS::access_groupagent - Object methods for access_groupagent records

SYNOPSIS

 use FS::access_groupagent;

 $record = new FS::access_groupagent \%hash;
 $record = new FS::access_groupagent { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::access_groupagent object represents an group reseller virtualization. FS::access_groupagent inherits from FS::Record. The following fields are currently supported:

groupagentnum - primary key; groupnum -; agentnum -

METHODS

new HASHREF
Creates a new group reseller virtualization. To add the record to the database, see "insert".
Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.
insert
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
delete
Delete this record from the database.
replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
check
Checks all fields to make sure this is a valid group reseller virtualization. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
agent
Returns the associated FS::agent object.
access_group
Returns the associated FS::access_group object.

BUGS

SEE ALSO

FS::Record, schema.html from the base documentation.

Retrieved from "http://secure.freeside.biz/mediawiki/index.php?title=Freeside:3:Documentation:Developer/FS/access_groupagent&oldid=8285"