source: main/trunk/greenstone3/web/WEB-INF/classes/QBRWebServicesHelp.properties@ 26546

Last change on this file since 26546 was 26546, checked in by ak19, 11 years ago

All backslash-n (newline) chars replaced with html break since that's what the interface_basic.properties file for English uses for newline.
File size: 11.5 KB
Line 
1#### Help properties file for Greenstone3's QBR web services
2
3describe=String describe(String lang, String subsetOption)<br />Sends a describe message to the MessageRouter.<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 35-41.<br />Param lang: the language of the display strings in the response.<br />If "", assumed to be "en" for English.<br />Param subsetOption: the requested list of items to return in the response.<br />For the Message Router the value of this can be collectionList,<br />serviceClusterList, serviceList, siteList.<br />
4
5describeCollection=String describeCollection(String collection, String lang,<br />\tString subsetOption)<br />For sending Describe messages to Collections.<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 35-41.<br />Param collection: the name of the Collection that this describe request<br />is sent to.<br />Param lang: the language of the display content in the response.<br />If "", assumed to be "en" for English.<br />Param subsetOption: the requested list of items to return in the<br />response. For Collections the value of this can be metadataList,<br />serviceList, displayItemList.<br />
6
7describeServiceCluster=String describeServiceCluster(String serviceCluster, String lang,<br />\tString subsetOption)<br />For sending Describe messages to Service Clusters.<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 35-41.<br />Param serviceCluster: the name of the Service Cluster that this describe<br />request is sent to.<br />Param lang: the language of the display content in the response.<br />If "", assumed to be "en" for English.<br />Param subsetOption: the requested list of items to return in the<br />response. For Service Clusters the value of this can be metadataList,<br />serviceList, displayItemList.<br />
8
9describeCollectionService=String describeCollectionService(String collection, String service,<br />\tString lang, String subsetOption)<br />For sending a describe message to a Collection's Service.<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 35-41.<br />Param collection: the name of the Collection whose service this describe<br />request is sent to.<br />Param service: the name of the Service (of that collection) to which<br />this describe request is sent.<br />Param lang: the language of the display content in the response.<br />If "", assumed to be "en" for English.<br />Param subsetOption: the requested list of items to return in the<br />response. For Services the value of this can be paramList, displayItemList.<br />
10
11describeService=String describeService(String service, String lang, String subsetOption)<br />For sending a describe message to a Service hosted by the Message<br />Router (no collection).<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 35-41.<br />Param service: the name of the MessageRouter's Service to which this<br />describe request is sent.<br />Param lang: the language of the display content in the response.<br />Param subsetOption: the requested list of items to return in the<br />response. For Services the value of this can be paramList, displayItemList.<br />
12
13query=String query(String collection, String service,<br />\tString lang, Map nameToValsMap)<br />For executing a (process-type message) query-type service.<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - page 45.<br />Param collection: the name of the Collection whose query service this<br />query-process request is sent to. For "" the Message Router is assumed.<br />Param service: the name of the Query Service (of that collection) to<br />which this request is sent.<br />Param lang: the language of the display content in the response.<br />Param nameToValsMap: a Map of the (fieldname, value) pairs for the<br />parameters of the query. The field names should be those recognised by<br />Greenstone 3. That is, the names must exist for the (Collection-)Service<br />Query that this message is sent To (as given in "to" argument).<br />For names of Greenstone-accepted arguments, see<br />http://wiki.greenstone.org/wiki/index.php/Actions_and_Arguments<br />
14
15retrieveDocumentContent=String retrieveDocumentContent(String collection, String lang,<br />\tString[] docNodeIDs)<br />DocumentContentRetrieve request sent to a collection's<br />DocumentContentRetrieve service (see manual, p.48).<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - page 48<br />Param collection: the name of the Collection whose<br />DocumentContentRetrieve is requested<br />Param lang: the language of the display content in the response<br />Param docNodeIDs: the list of documentNodeIDs for which the content<br />ought to be retrieved.<br />
16
17retrieveEntireDocumentStructure=String retrieveEntireDocumentStructure(String collection,<br />\tString lang, String[] docNodeIDs)<br />DocumentStructureRetrieve request sent to a collection's<br />DocumentStructureRetrieve service (manual pp.48, 49) to retrieve<br />the entire document structure.<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 48, 49<br />Param collection: the name of the Collection whose<br />DocumentStructureRetrieve is requested.<br />Param lang: the language of the display content in the response.<br />Param docNodeIDs: the list of documentNodeIDs for which the<br />entire structure ought to be retrieved.<br />
18
19retrieveDocumentStructure=String retrieveDocumentStructure(String collection,<br />\tString lang, String[] docNodeIDs, String[] structure, String[] info)<br />DocumentStructureRetrieve request sent to a collection's<br />DocumentStructureRetrieve service (manual pp.48, 49) to retrieve<br />the specified part of the document's structure.<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 48, 49<br />Param collection: the name of the Collection whose<br />DocumentStructureRetrieve is requested.<br />Param lang: the language of the display content in the response.<br />Param docNodeIDs: the list of documentNodeIDs for which the<br />structure ought to be retrieved.<br />Param structure: specifies what structure information needs to<br />be retrieved. The values can be one or more of ancestors, parent,<br />siblings, children, descendents (NOTE SPELLING), entire.<br />Param info: for specifying extra information to be retrieved.<br />Possible values for info parameters are numSiblings, siblingPosition,<br />numChildren.<br />
20
21retrieveAllDocumentMetadata=String retrieveAllDocumentMetadata(String collection,<br />\tString lang, String[] docNodeIDs)<br />DocumentMetadataRetrieve request sent to a collection's<br />DocumentMetadataRetrieve service to retrieve all of a document's metadata.<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - page. 47<br />Param collection: the name of the Collection whose<br />DocumentMetadataRetrieve is requested<br />Param lang: the language of the display content in the response<br />Param docNodeIDs: the list of documentNodeIDs for which the<br />structure ought to be retrieved.<br />
22
23retrieveDocumentMetadata=String retrieveDocumentMetadata(String collection,<br />\tString lang, String[] docNodeIDs, String[] metaNames)<br />DocumentMetadataRetrieve service to retrieve some specific<br />metadata values of a document. (Manual on page 47.)<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - page 47<br />Param collection: the name of the Collection whose<br />DocumentContentRetrieve is requested.<br />Param lang: the language of the display content in the response<br />Param docNodeIDs: the list of documentNodeIDs for which the<br />structure ought to be retrieved.<br />Param metaNames: a list of metadata names which are requested<br />to be fetched for the specified documents.<br />
24
25retrieveAllBrowseMetadata=String retrieveAllBrowseMetadata(String collection,<br />\tString categoryName, String lang, String[] nodeIDs)<br />Retrieve all classification Metadata for browsing (sent to the<br />ClassifierBrowseMetadataRetrieve service).<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 47, 48<br />Param collection: the name of the Collection whose<br />ClassifierBrowseMetadataRetrieve service is called<br />Param categoryName: name of the browsing category, usually<br />ClassifierBrowse. (If left as \"\", then it defaults to ClassifierBrowse)<br />Param lang: the language of the display content in the response<br />Param nodeIDs: the list of document or classifier NodeIDs<br />for which the metadata ought to be retrieved.<br />
26
27retrieveBrowseMetadata=String retrieveBrowseMetadata(String collection,<br />\tString categoryName, String lang, String[] nodeIDs, String[] metaNames)<br />ClassifierBrowseMetadataRetrieve service to retrieve some specific<br />metadata values of a document.<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 47, 48<br />Param collection: the name of the Collection whose<br />ClassifierBrowseMetadataRetrieve service is called<br />Param categoryName: name of the browsing category, usually<br />ClassifierBrowse. (If left as \"\", then it defaults to ClassifierBrowse)<br />Param lang: the language of the display content in the response<br />Param nodeIDs: the list of document or classifier NodeIDs<br />for which the metadata ought to be retrieved.<br />Param metaNames: a list of metadata names which are requested<br />to be fetched for the specified documents or classifiers.<br />
28
29browseDescendants=String browseDescendants(String collection,<br />\tString browseService, String lang, String[] classifierNodeIDs)<br />To send a browse request for all the descendants of a classifier node.<br />Useful for getting the entire structure of a top-level <classifierNode><br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - page 46<br />Param collection: the name of the Collection whose browse Classifier<br />Browse Service is called<br />Param browseService: the name of the (Classifier) Browse Service (of<br />the given collection) to which this request message is sent.<br />Param lang: the language of the display content in the response<br />Param classifierNodeIDs: an array of classifierNodeIDs for which the<br />structures ought to be retrieved.<br />
30
31browse=String browse(String collection, String browseService,<br />\tString lang, String[]classifierNodeIDs, String[] structureParams)<br />To send a browse request for specific parts of a classifier node<br />(children, ancestors, descendants). Useful for getting specific parts<br />of the structure of a top-level <classifierNode>.<br />See http://www.greenstone.org/docs/greenstone3/manual.pdf - page 46<br />Param collection: the name of the Collection whose browse Classifier<br />Browse Service is called.<br />Param browseService: the name of the (Classifier) Browse Service (of<br />the given collection) to which this request message is sent.<br />Param lang: the language of the display content in the response<br />Param classifierNodeIDs is the list of classifierNodeIDs for which the<br />structure ought to be retrieved.<br />Param structureParams: the list of parameters indicating what structure<br />information is requested. Accepted values are ancestors, parent,<br />siblings, children, descendants.<br />
32
33help=String help()<br />Returns a String containing help usage and the list of methods<br />supported by Greenstone 3's web services.<br />
34
35helpWithMethod=String helpWithMethod(String methodName)<br />Returns a String containing a description of the requested web<br />service method denoted by "methodName".<br />Param methodName: the name of the web service operation for which<br />the help description string is to be returned.<br />
Note: See TracBrowser for help on using the repository browser.