[LON-CAPA-cvs] cvs: nsdl /lib/perl/Apache/NSDL FromTheGateway.pm
harris41
lon-capa-cvs@mail.lon-capa.org
Mon, 06 May 2002 03:46:22 -0000
harris41 Sun May 5 23:46:22 2002 EDT
Added files:
/nsdl/lib/perl/Apache/NSDL FromTheGateway.pm
Log:
NSDL Gateway: Software Structure: BUG 391
(Enhancement); perl syntax OK; considered complete
Index: nsdl/lib/perl/Apache/NSDL/FromTheGateway.pm
+++ nsdl/lib/perl/Apache/NSDL/FromTheGateway.pm
# Apache::NSDL::FromTheGateway
#
# FromTheGateway.pm
# API for passing information to NSDL from the Gateway Server
#
# For more documentation, read the POD documentation
# of this module with the perldoc command:
#
# perldoc ./FromTheGateway.pm
#
# Brief description
# =================
#
# This module contains functionality for
# transferring information from NSDL to the Gateway Server.
#
# In terms of the overall data flow, the
# '=====>' below indicates the role of this
# module.
#
# NSDL ---------> Gateway --------> LON-CAPA
# LON-CAPA =====> Gateway --------> NSDL
#
# SUBROUTINES:
# NSDL->view_LONCAPAgateway_results
# NSDL->view_LONCAPAgateway_metadata_record
# NSDL->access_LONCAPAgateway_resource
# NSDL->search_against_LONCAPAgateway
# Year 2002
# Scott Harrison
# February-May
#
###
package Apache::NSDL::FromTheGateway;
# ================================================================ DEPENDENCIES
use strict; # enforce handling of variables, references and subroutines
# ============================================================ MODULE VARIABLES
my $VERSION = sprintf("%d.%02d", q$Revision: 1.1 $ =~ /(\d+)\.(\d+)/);
# ================================================================= SUBROUTINES
# ------------------------------------------- NSDL->view_LONCAPAgateway_results
sub view_LONCAPAgateway_results {
# Not yet implemented
# Need to specifically characterize INPUT arguments and OUTPUT data
}
# ----------------------------------- NSDL->view_LONCAPAgateway_metadata_record
sub view_LONCAPAgateway_metadata_record {
# Not yet implemented
# Need to specifically characterize INPUT arguments and OUTPUT data
}
# ---------------------------------------- NSDL->access_LONCAPAgateway_resource
sub access_LONCAPAgateway_resource {
# Not yet implemented
# Need to specifically characterize INPUT arguments and OUTPUT data
}
# ----------------------------------------- NSDL->search_against_LONCAPAgateway
sub search_against_LONCAPAgateway {
# Not yet implemented
# Need to specifically characterize INPUT arguments and OUTPUT data
}
1;
__END__
=pod
=head1 NAME
B<Apache::NSDL::FromTheGateway> - API for passing information to NSDL from the Gateway Server
=head1 SYNOPSIS
use Apache::NSDL::FromTheGateway;
my $arrayref=
Apache::NSDL::FromTheGateway::view_LONCAPAgateway_results
($OAI_protocol_request);
=head1 DESCRIPTION
This module contains functionality for
transferring information to NSDL from the Gateway Server.
In terms of the overall data flow, the
'=====>' below indicates the role of this
module.
NSDL ---------E<gt> Gateway --------E<gt> LON-CAPA
B<LON-CAPA =====E<gt>> Gateway --------E<gt> NSDL
=head2 EXIT CODES
The subroutines of this module all output an exit code which
describes the status of function completion. The exit code
may be followed by a more descriptive message such as:
FORMATERROR:Sun May 5 20:15:16 GMT 2002:missing 'protocol://' pattern
=over 4
=item *
B<'SUCCESS'>, information was found and is being returned
=item *
B<'EMPTY'>, everything functioned properly, but no information was present
=item *
B<'BADEMPTY'>, everything appeared to function properly, but no information
was present (which defies expectation); this is useful for detecting phantom
cases of connectivity when verifying test cases of vertical software partitions
=item *
B<'TIMEOUT'>, the request is taking WAY too long
=item *
B<'FORMATERROR'>, the input argument is not formatted correctly in a way that
can be processed by the NSDL server
=item *
B<'CONNECTIONFAILURE'>, the NSDL server cannot be contacted
=back
=head2 SUBROUTINES
Note that the subroutines all output an exit code which
describes the status of function completion.
In the case of failed function completion, the other
output argument(s) will typically only be 'NULL' values.
=over 4
=item B<Apache::NSDL::view_LONCAPAgateway_results>
=over 4
=item B<Input> - Scalar string
Memory location of Gateway Server results.
=item B<Output> - Scalar string, Scalar string reference
An exit code is returned as a scalar string.
View the Gateway Server results.
=item B<Description>
This facilitates the viewing of LON-CAPA record lists.
B<This relates to information that has passed
to NSDL I<from the> GATEWAY>.
=back
=item B<Apache::NSDL::view_LONCAPAgateway_metadata_record>
=over 4
=item B<Input> - Scalar string
Identifier for a specific LON-CAPA metadata record.
=item B<Output> - Scalar string, Scalar string reference
An exit code is returned as a scalar string.
A pointer to the metadata.
=item B<Description>
This provides the content of the resource matching a given request.
B<The information has passed to NSDL I<from the> GATEWAY>.
=back
=item B<Apache::NSDL::access_LONCAPAgateway_resource>
=over 4
=item B<Input> - Scalar string
Identifier for LON-CAPA resource.
=item B<Output> - Scalar string, Scalar string
An exit code is returned as a scalar string.
A list of records returned via an array reference.
=item B<Description>
This accepts access to a LON-CAPA resource.
B<The information has passed to NSDL I<from the> GATEWAY>.
=back
=item B<Apache::NSDL::search_against_LONCAPAgateway>
=over 4
=item B<Input> - Scalar string
Set of search expressions and corresponding fields to pass onto the
LONCAPAgateway.
=item B<Output> - Scalar string, Scalar array reference
An exit code is returned as a scalar string.
A pointer to the location of search results is returned.
=item B<Description>
This models the functionality by which an NSDL server will pass a search
request to the NSDL-LONCAPA Gateway Server.
This launches the search request and receives a pointer as to
where the results will be.
=back
=back
=head1 README
B<Apache::NSDL::FromTheGateway>
is part of the NSDL-LONCAPA Gateway Server system.
Please see http://nsdl.lon-capa.org/ for more information.
=head1 AUTHOR
Scott Harrison, 2002
=head1 PREREQUISITES
This module requires the C<strict> module.
=head1 COREQUISITES
Apache::NSDL::ToTheGateway
Apache::GATEWAY::ToNSDL
Apache::GATEWAY::FromNSDL
Apache::GATEWAY::ToLONCAPA
Apache::GATEWAY::FromLONCAPA
Apache::LONCAPA::FromTheGateway
Apache::LONCAPA::ToTheGateway
=head1 SEE ALSO
http://www.lon-capa.org/
http://www.smete.org/
Also visit the other Apache::NSDL::*, Apache::LONCAPA::*,
and Apache::GATEWAY::* manpages.
=head1 OSNAMES
linux
=cut