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