/ 
MOBY-1.16
River stage one • 1 direct dependent • 1 total dependent
/ MOBY::Client::ServiceInstance

NAME

MOBY::Client::ServiceInstance - a small object describing a MOBY service

SYNOPSIS

 use MOBY::Client::ServiceInstance;
 my $Instance = MOBY::Client::ServiceInstance->new(
     authority => 'bioinfo.pbi.nrc.ca',
     authoritative => 0,
     URL => http://bioinfo.pbi.nrc.ca/runMe.pl,
     contactEmail => markw@illumin.com,
     name => 'marksFabulousService',
     type => 'Retrieve',
     input => [$SimpleArticle],
     category => 'moby',
     output => [$CollectionArticle, $SecondaryArticle],
     description => 'retrieves random sequences from a database',
	 XML => $xml, # the XML from MOBY::Central::findService
	 );

DESCRIPTION

a simple get/set object to hold information about a service instance.

This object is created by MOBY::Client::Central, and is not particularly useful for anyone else to create it... it is meant to be read-only

AUTHORS

Mark Wilkinson (markw at illuminae dot com)

BioMOBY Project: http://www.biomoby.org

METHODS

new

Title     :	new
Usage     :	my $MOBY = MOBY::Client::ServiceInstance->new(%args)
Function  :	create ServiceInstance object
Returns   :	MOBY::Client::ServiceInstance object
Args      :    authority : required : string : default NULL
                           the URI of the service provider
               name      : required : string : default NULL
                           the name of the service
               type      : required : string : default NULL
                           the type of service from ontology
               input    : optional : listref : default empty listref
                           the SimpleArticle and CollectionArticle inputs for the service
               secondary    : optional : listref : default empty listref
                           the SecondaryArticle inputs for the service
               output    : optional : listref : default empty listref
                           the SimpleArticle and CollectionArticle outputs for the service
               description : required : string : default NULL
                           human-readable description of service

authority

Title     :	authority
Usage     :	$URI = $Service->authority($arg)
Args      :    (optional) scalar string with authority URI
Function  :	get/set authority
Returns   :	string

name

Title     :	name
Usage     :	$name = $Service->name($arg)
Args      :    (optional) scalar string with service name
Function  :	get/set name
Returns   :	string

type

Title     :	type
Usage     :	$type = $Service->type($arg)
Args      :    (optional) scalar string with servivce type ontology term
Function  :	get/set type
Returns   :	string

category

Title     :	category
Usage     :	$category = $Service->category($arg)
Args      :    (optional) scalar string with moby service category ['moby' | 'post' | 'moby-async']
Function  :	get/set category
Returns   :	string

input

Title     :	input
Usage     :	$input = $Service->input($args)
Args      :    (optional) listref of SimpleArticle, and/or CollectionArticles
Function  :	get/set input
Returns   :	listref of MOBY::Client::SimpleArticle
               and/or MOBY::Client::CollectionArticle objects

output

Title     :	output
Usage     :	$output = $Service->output($args)
Args      :    (optional) listref of SimpleArticle,
               CollectionArticle, or SecondaryArticle objects
Function  :	get/set output
Returns   :	listref of MOBY::Client::SimpleArticle
               and/or MOBY::Client::CollectionArticle objects

secondary

Title     :	secondary
Usage     :	$output = $Service->secondary($args)
Args      :    (optional) listref of SecondaryArticle objects
Function  :	get/set secondary inputs
Returns   :	listref of MOBY::Client::SecondaryArticle

description

Title     :	description
Usage     :	$description = $Service->description($arg)
Args      :    (optional) scalar string with description
Function  :	get/set description
Returns   :	string

authoritative

Title     :	authoritative
Usage     :	$auth = $Service->authoritative(1|0)
Args      :    (optional) boolean 1 or 0
Function  :	get/set authoritative flag
Returns   :	current value

URL

Title     :    URL
Usage     :	$URL = $Service->URL($url)
Args      :    (optional) string representing a URL
Function  :	get/set service URL endpoint
Returns   :	current value

contactEmail

Title     :    contactEmail
Usage     :	$email = $Service->contactEmail($email)
Args      :    (optional) string representing an email address
Function  :	get/set service email address
Returns   :	current value

LSID

Title     :    LSID
Usage     :	$lsid = $Service->LSID()
Args      :    none
Function  :	get (readonly) service instance LSID
Returns   :	current value as scalar string

signatureURL

Title     :    signatureURL
Usage     :	$sig = $Service->signatureURL()
Args      :    (optional) string representing a URL
Function  :	get/set the location of the RDF document that describes this service
Returns   :	current value as scalar string

registry

Title     :	registry
Usage     :	$regname = $Service->registry([$description])
Function  :	get/set registry
Returns   :	string

unitTests

Title     :	unitTests
Usage     :	$test = $Service->unitTests()
Function  :	get/set the MobyUnitTests for this service
Returns   :	a listref of MOBY::Client::MobyUnitTest objects for this service