#!/usr/bin/perl
package Note_link;

#####################################################################
# Author : Shuai Weng 
# Date   : Sept. 2002
# 
# See documentation for the usage details. 
#    
# http:///usr/local/dicty/www_dictybase/db/lib/html/dictyBase/programmer/object_docs/Note_link.html
#
#####################################################################

use strict;
use DBI;
use Carp;
use vars qw (@ISA %allowedConstructors);
use dictyBase_Table;
@ISA = qw (dictyBase_Table); # base class

# Class Globals

# put column names in the hash below, that are able to uniquely
# specify a row in the table

%allowedConstructors = ('note_link_no'=>undef,
			'note_no:tab_name:primary_key'=>undef);
   
####################################################################
sub DESTROY{
####################################################################
# nothing needs to be done 

}


####################################################################
1; #################################################################
####################################################################

=pod

=head1 Name

Note_link.pm

=head1 Description

This perl object (Note_link) acts as container for Note link info in oracle database. Once an object has been instantiated, several methods are available to retrieve the attributes of the object. 


=head1 Instantiating a New Note_link Object

To instantiate a new Note_link object, you may use one of following syntaxes: 

my $Obj = Note_link->new(dbh=>$dbh,
			 note_link_no=>$noteLinkNo);


OR

my $Obj = Note_link->new(dbh=>$dbh,
			 note_no=>$noteNo,
			 tab_name=>$tabNm,
			 primary_key=>$prikey);


where $dbh is a valid database handle to either dictyBase or SDEV. All passed in values must be valid values for the columns that were provided, otherwise the script will die, with an appropriate error message.
 

=head1 Accessor Methods


All accessor methods take the form of : 


my $colVal = $Obj->column_name, eg: 


my $dateCreated = $Obj->date_created; 


etc. You can use an accessor for any valid column in the Note_link table. 

See valid columns in abstact table:

http:///usr/local/dicty/www_dictybase/db/lib/cgi-bin/dictyBase/tableSpecifications?table=NOTE_LINK


=head1 getRow method

Usage:

my $row = $Obj->getRow;

This method returns a tab-delimited row from note_link table.

=head1 Insert and delete Methods

You can also use 'Insert' class method and 'delete' 
instance method for inserting new row into database or 
deleting info for a specified row. 

See dictyBase_Table documentation for usage details :

Insert : http:///usr/local/dicty/www_dictybase/db/lib/staff/dictyBase/programmer/dictyBase_Table.html#Insert_Method

Delete : http:///usr/local/dicty/www_dictybase/db/lib/staff/dictyBase/programmer/dictyBase_Table.html#Delete_Method


=head1 Author

Shuai Weng

shuai@genome.stanford.edu

=cut