Freeside:4:Documentation:Developer/FS/msa

From Freeside
< Freeside:4:Documentation:Developer‎ | FS
Revision as of 08:24, 18 November 2015 by Jeremyd (talk | contribs) (Edit via perl MediaWiki framework (1.13))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

NAME

FS::msa - Object methods for msa records

SYNOPSIS

 use FS::msa;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::msa object represents a MSA. FS::msa inherits from FS::Record. The following fields are currently supported:

msanum
primary key
description
description

METHODS

new HASHREF
Creates a new MSA. To add the MSA 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 MSA. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

SEE ALSO

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