DESCRIPTION

This is an interface definition. There is NO implementation in this module with the exception that certain calls to required parameters have get/setter functions in this module (that can be overridden)

query_collection_input

Title : query_collection_input
Usage : my $un = $API->query_collection_input(%arg)
Function : get the collection input information for a given service
Args : service_lsid => String
Returns : listref of hashrefs:
[{collection_input_id => Integer
article_name => String}, ...]
one hashref for each collection that service consumes
Notes : the fact that it returns a collection_input_id is bad since this
is only useful to an SQL-based API...

insert_collection_input

Title : insert_collection_input
Usage : my $un = $API->insert_collection_input(%args)
Function : Inserts a Collection input into the database
Args : article_name => String,
service_instance_lsid => String,
Returns : Integer insertid
Notes : the fact that it returns an insertid is bad since this
is only useful to an SQL-based API...

delete_object

Title : delete_object
Usage : my $un = $API->delete_object(%args)
Function : Deletes an object and any relationships it has from the database
Args : type => String - lsid or term identifying a particular object
Returns : ($err, $errstr)
$err = 1 if there was an delete error, 0 if successful
$errstr = String error message if there was an error

query_service_existence

Title : query_service_existence
Usage : my $un = $API->query_service_existence(%args)
Function : Executes a query to check if the service exists in the database
Args : servicename => String
authority_uri => String
Returns : 1 if service exists
0 if no such service instance
Notes : Only allows querying by URI of the authority and service name

get_details_for_id_list

Title : get_deails_for_id_list
Usage : my $un = $API->get_all_relationships($ontology, $field_list, $id_list)
Function : Retrieve details specified in @$field_list from $ontology for ids in @$id_list
Args : $ontology => String - name of the table ontology
$field_list => Reference to array of Strings representing table fields in $ontology
$id_list => Reference to array of Integers representing ${ontology}_ids
Returns : reference to hash with the following structure:
$resultHash->{Integer ${ontology}_id}->{String field_name} = field_value
Notes : This function is generic with respect to which details (fields) are retrieved, but
is restricted to those tables whose name is identical to the ontology name (i.e.
currently 'object', 'service', 'namespace' and 'relationship')
Makes use of the 'select ... from ... where ... in (<LIST>)' statement syntax
in order to reduce the number of DB interactions
Used in MOBY::OntologyServer::Relationships, but maybe useful for other purposes...