Annotation of nsdl/lib/perl/Apache/LONCAPA/ToTheGateway.pm, revision 1.1
1.1 ! harris41 1: # Apache::LONCAPA::ToTheGateway
! 2: #
! 3: # ToTheGateway.pm
! 4: # API for passing information from LONCAPA to the Gateway Server
! 5: #
! 6: # For more documentation, read the POD documentation
! 7: # of this module with the perldoc command:
! 8: #
! 9: # perldoc ./ToTheGateway.pm
! 10: #
! 11: # Brief description
! 12: # =================
! 13: #
! 14: # This module contains functionality for
! 15: # transferring information from LON-CAPA to the Gateway Server.
! 16: #
! 17: # In terms of the overall data flow, the
! 18: # '=====>' below indicates the role of this
! 19: # module.
! 20: #
! 21: # NSDL ---------> Gateway --------> LON-CAPA
! 22: # LON-CAPA =====> Gateway --------> NSDL
! 23: #
! 24: # SUBROUTINES:
! 25: # LONCAPA->answer_search_request
! 26: # LONCAPA->answer_metadata_record_request
! 27: # LONCAPA->answer_resource_request
! 28:
! 29: # Year 2002
! 30: # Scott Harrison
! 31: # February-May
! 32: #
! 33: ###
! 34:
! 35: package Apache::LONCAPA::ToTheGateway;
! 36:
! 37: # ================================================================ DEPENDENCIES
! 38: use strict; # enforce handling of variables, references and subroutines
! 39:
! 40: # ============================================================ MODULE VARIABLES
! 41: my $VERSION = sprintf("%d.%02d", q$Revision: 1.4 $ =~ /(\d+)\.(\d+)/);
! 42:
! 43: # ================================================================= SUBROUTINES
! 44:
! 45:
! 46: # ---------------------------------------------- LONCAPA->answer_search_request
! 47: sub answer_search_request {
! 48: # Not yet implemented
! 49: # Need to specifically characterize INPUT arguments and OUTPUT data
! 50: }
! 51:
! 52: # ------------------------------------- LONCAPA->answer_metadata_record_request
! 53: sub answer_metadata_record_request {
! 54: # Not yet implemented
! 55: # Need to specifically characterize INPUT arguments and OUTPUT data
! 56: }
! 57:
! 58: # -------------------------------------------- LONCAPA->answer_resource_request
! 59: sub answer_resource_request {
! 60: # Not yet implemented
! 61: # Need to specifically characterize INPUT arguments and OUTPUT data
! 62: }
! 63:
! 64: 1;
! 65:
! 66: __END__
! 67:
! 68: =pod
! 69:
! 70: =head1 NAME
! 71:
! 72: B<Apache::LONCAPA::ToTheGateway> - API for passing information from LONCAPA to the Gateway Server
! 73:
! 74: =head1 SYNOPSIS
! 75:
! 76: use Apache::LONCAPA::ToTheGateway;
! 77:
! 78: my $arrayref=
! 79: Apache::LONCAPA::ToTheGateway::answer_search_request
! 80: ($search_request);
! 81:
! 82: =head1 DESCRIPTION
! 83:
! 84: This module contains functionality for
! 85: transferring information to LON-CAPA from the Gateway Server.
! 86:
! 87: In terms of the overall data flow, the
! 88: '=====>' below indicates the role of this
! 89: module.
! 90:
! 91: NSDL ---------E<gt> B<Gateway ========E<gt> LON-CAPA>
! 92:
! 93: LON-CAPA -----E<gt> Gateway --------E<gt> NSDL
! 94:
! 95: =head2 EXIT CODES
! 96:
! 97: The subroutines of this module all output an exit code which
! 98: describes the status of function completion. The exit code
! 99: may be followed by a more descriptive message such as:
! 100:
! 101: FORMATERROR:Sun May 5 20:15:16 GMT 2002:missing 'protocol://' pattern
! 102:
! 103: =over 4
! 104:
! 105: =item *
! 106:
! 107: B<'SUCCESS'>, information was found and is being returned
! 108:
! 109: =item *
! 110:
! 111: B<'EMPTY'>, everything functioned properly, but no information was present
! 112:
! 113: =item *
! 114:
! 115: B<'BADEMPTY'>, everything appeared to function properly, but no information
! 116: was present (which defies expectation); this is useful for detecting phantom
! 117: cases of connectivity when verifying test cases of vertical software partitions
! 118:
! 119: =item *
! 120:
! 121: B<'TIMEOUT'>, the request is taking WAY too long
! 122:
! 123: =item *
! 124:
! 125: B<'FORMATERROR'>, the input argument is not formatted correctly in a way that
! 126: can be processed by the NSDL server
! 127:
! 128: =item *
! 129:
! 130: B<'CONNECTIONFAILURE'>, the NSDL server cannot be contacted
! 131:
! 132: =back
! 133:
! 134: =head2 SUBROUTINES
! 135:
! 136: Note that the subroutines all output an exit code which
! 137: describes the status of function completion.
! 138:
! 139: In the case of failed function completion, the other
! 140: output argument(s) will typically only be 'NULL' values.
! 141:
! 142: =over 4
! 143:
! 144: =item B<Apache::LONCAPA::answer_search_request>
! 145:
! 146: =over 4
! 147:
! 148: =item B<Input> - Scalar string
! 149:
! 150: Memory location of Gateway Server results.
! 151:
! 152: =item B<Output> - Scalar string, Scalar string reference
! 153:
! 154: An exit code is returned as a scalar string.
! 155:
! 156: View the Gateway Server results.
! 157:
! 158: =item B<Description>
! 159:
! 160: This facilitates the passing of LON-CAPA search results
! 161: B<This relates to information that has passed
! 162: from LON-CAPA I<to the> GATEWAY>.
! 163:
! 164: =item B<Status of Implementation>
! 165:
! 166: n/a
! 167:
! 168: =back
! 169:
! 170: =item B<Apache::LONCAPA::answer_metadata_record_request>
! 171:
! 172: =over 4
! 173:
! 174: =item B<Input> - Scalar string
! 175:
! 176: Identifier for a specific LON-CAPA metadata record.
! 177:
! 178: =item B<Output> - Scalar string, Scalar string reference
! 179:
! 180: An exit code is returned as a scalar string.
! 181:
! 182: A pointer to the metadata.
! 183:
! 184: =item B<Description>
! 185:
! 186: This provides the metadata of the resource matching a given identifier.
! 187: B<The information has passed from LONCAPA I<to the> GATEWAY>.
! 188:
! 189: =item B<Status of Implementation>
! 190:
! 191: n/a
! 192:
! 193: =back
! 194:
! 195: =item B<Apache::LONCAPA::answer_resource_request>
! 196:
! 197: =over 4
! 198:
! 199: =item B<Input> - Scalar string
! 200:
! 201: Identifier for LON-CAPA resource.
! 202:
! 203: =item B<Output> - Scalar string, Scalar string reference.
! 204:
! 205: An exit code is returned as a scalar string.
! 206:
! 207: Pointer to information about accessing LON-CAPA resource.
! 208:
! 209: =item B<Description>
! 210:
! 211: This gives access to a LON-CAPA resource.
! 212: B<The information has passed from LON-CAPA I<to the> GATEWAY>.
! 213:
! 214: =item B<Status of Implementation>
! 215:
! 216: n/a
! 217:
! 218: =back
! 219:
! 220: =back
! 221:
! 222: =head1 README
! 223:
! 224: B<Apache::LONCAPA::ToTheGateway>
! 225: is part of the NSDL-LONCAPA Gateway Server system.
! 226: Please see http://nsdl.lon-capa.org/ for more information.
! 227:
! 228: =head1 AUTHOR
! 229:
! 230: Scott Harrison, 2002
! 231:
! 232: =head1 PREREQUISITES
! 233:
! 234: This module requires the C<strict> module.
! 235:
! 236: =head1 COREQUISITES
! 237:
! 238: Apache::NSDL::FromTheGateway
! 239: Apache::NSDL::ToTheGateway
! 240: Apache::GATEWAY::ToNSDL
! 241: Apache::GATEWAY::FromNSDL
! 242: Apache::GATEWAY::ToLONCAPA
! 243: Apache::GATEWAY::FromLONCAPA
! 244: Apache::LONCAPA::FromTheGateway
! 245:
! 246: =head1 SEE ALSO
! 247:
! 248: http://www.lon-capa.org/
! 249:
! 250: http://www.smete.org/
! 251:
! 252: Also visit the other Apache::NSDL::*, Apache::LONCAPA::*,
! 253: and Apache::GATEWAY::* manpages.
! 254:
! 255: =head1 OSNAMES
! 256:
! 257: linux
! 258:
! 259: =cut
! 260:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to ToTheGateway.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / nsdl / lib / perl / Apache / LONCAPA