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

Last change on this file since 24158 was 15299, checked in by ak19, 16 years ago

Help properties file used by the QBRSOAPServer web services
File size: 10.8 KB
Line 
1#### Help properties file for Greenstone3's QBR web services
2
3describe=String describe(String lang, String subsetOption)\nSends a describe message to the MessageRouter.\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 35-41.\nParam lang: the language of the display strings in the response.\nIf "", assumed to be "en" for English.\nParam subsetOption: the requested list of items to return in the response.\nFor the Message Router the value of this can be collectionList,\nserviceClusterList, serviceList, siteList.\n
4
5describeCollection=String describeCollection(String collection, String lang,\n\tString subsetOption)\nFor sending Describe messages to Collections.\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 35-41.\nParam collection: the name of the Collection that this describe request\nis sent to.\nParam lang: the language of the display content in the response.\nIf "", assumed to be "en" for English.\nParam subsetOption: the requested list of items to return in the\nresponse. For Collections the value of this can be metadataList,\nserviceList, displayItemList.\n
6
7describeServiceCluster=String describeServiceCluster(String serviceCluster, String lang,\n\tString subsetOption)\nFor sending Describe messages to Service Clusters.\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 35-41.\nParam serviceCluster: the name of the Service Cluster that this describe\nrequest is sent to.\nParam lang: the language of the display content in the response.\nIf "", assumed to be "en" for English.\nParam subsetOption: the requested list of items to return in the\nresponse. For Service Clusters the value of this can be metadataList,\nserviceList, displayItemList.\n
8
9describeCollectionService=String describeCollectionService(String collection, String service,\n\tString lang, String subsetOption)\nFor sending a describe message to a Collection's Service.\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 35-41.\nParam collection: the name of the Collection whose service this describe\nrequest is sent to.\nParam service: the name of the Service (of that collection) to which\nthis describe request is sent.\nParam lang: the language of the display content in the response.\nIf "", assumed to be "en" for English.\nParam subsetOption: the requested list of items to return in the\nresponse. For Services the value of this can be paramList, displayItemList.\n
10
11describeService=String describeService(String service, String lang, String subsetOption)\nFor sending a describe message to a Service hosted by the Message\nRouter (no collection).\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 35-41.\nParam service: the name of the MessageRouter's Service to which this\ndescribe request is sent.\nParam lang: the language of the display content in the response.\nParam subsetOption: the requested list of items to return in the\nresponse. For Services the value of this can be paramList, displayItemList.\n
12
13query=String query(String collection, String service,\n\tString lang, Map nameToValsMap)\nFor executing a (process-type message) query-type service.\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - page 45.\nParam collection: the name of the Collection whose query service this\nquery-process request is sent to. For "" the Message Router is assumed.\nParam service: the name of the Query Service (of that collection) to\nwhich this request is sent.\nParam lang: the language of the display content in the response.\nParam nameToValsMap: a Map of the (fieldname, value) pairs for the\nparameters of the query. The field names should be those recognised by\nGreenstone 3. That is, the names must exist for the (Collection-)Service\nQuery that this message is sent To (as given in "to" argument).\nFor names of Greenstone-accepted arguments, see\nhttp://wiki.greenstone.org/wiki/index.php/Actions_and_Arguments\n
14
15retrieveDocumentContent=String retrieveDocumentContent(String collection, String lang,\n\tString[] docNodeIDs)\nDocumentContentRetrieve request sent to a collection's\nDocumentContentRetrieve service (see manual, p.48).\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - page 48\nParam collection: the name of the Collection whose\nDocumentContentRetrieve is requested\nParam lang: the language of the display content in the response\nParam docNodeIDs: the list of documentNodeIDs for which the content\nought to be retrieved.\n
16
17retrieveEntireDocumentStructure=String retrieveEntireDocumentStructure(String collection,\n\tString lang, String[] docNodeIDs)\nDocumentStructureRetrieve request sent to a collection's\nDocumentStructureRetrieve service (manual pp.48, 49) to retrieve\nthe entire document structure.\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 48, 49\nParam collection: the name of the Collection whose\nDocumentStructureRetrieve is requested.\nParam lang: the language of the display content in the response.\nParam docNodeIDs: the list of documentNodeIDs for which the\nentire structure ought to be retrieved.\n
18
19retrieveDocumentStructure=String retrieveDocumentStructure(String collection,\n\tString lang, String[] docNodeIDs, String[] structure, String[] info)\nDocumentStructureRetrieve request sent to a collection's\nDocumentStructureRetrieve service (manual pp.48, 49) to retrieve\nthe specified part of the document's structure.\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 48, 49\nParam collection: the name of the Collection whose\nDocumentStructureRetrieve is requested.\nParam lang: the language of the display content in the response.\nParam docNodeIDs: the list of documentNodeIDs for which the\nstructure ought to be retrieved.\nParam structure: specifies what structure information needs to\nbe retrieved. The values can be one or more of ancestors, parent,\nsiblings, children, descendents (NOTE SPELLING), entire.\nParam info: for specifying extra information to be retrieved.\nPossible values for info parameters are numSiblings, siblingPosition,\nnumChildren.\n
20
21retrieveAllDocumentMetadata=String retrieveAllDocumentMetadata(String collection,\n\tString lang, String[] docNodeIDs)\nDocumentMetadataRetrieve request sent to a collection's\nDocumentMetadataRetrieve service to retrieve all of a document's metadata.\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - page. 47\nParam collection: the name of the Collection whose\nDocumentMetadataRetrieve is requested\nParam lang: the language of the display content in the response\nParam docNodeIDs: the list of documentNodeIDs for which the\nstructure ought to be retrieved.\n
22
23retrieveDocumentMetadata=String retrieveDocumentMetadata(String collection,\n\tString lang, String[] docNodeIDs, String[] metaNames)\nDocumentMetadataRetrieve service to retrieve some specific\nmetadata values of a document. (Manual on page 47.)\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - page 47\nParam collection: the name of the Collection whose\nDocumentContentRetrieve is requested.\nParam lang: the language of the display content in the response\nParam docNodeIDs: the list of documentNodeIDs for which the\nstructure ought to be retrieved.\nParam metaNames: a list of metadata names which are requested\nto be fetched for the specified documents.\n
24
25retrieveAllBrowseMetadata=String retrieveAllBrowseMetadata(String collection,\n\tString categoryName, String lang, String[] nodeIDs)\nRetrieve all classification Metadata for browsing (sent to the\nClassifierBrowseMetadataRetrieve service).\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 47, 48\nParam collection: the name of the Collection whose\nClassifierBrowseMetadataRetrieve service is called\nParam categoryName: name of the browsing category, usually\nClassifierBrowse. (If left as \"\", then it defaults to ClassifierBrowse)\nParam lang: the language of the display content in the response\nParam nodeIDs: the list of document or classifier NodeIDs\nfor which the metadata ought to be retrieved.\n
26
27retrieveBrowseMetadata=String retrieveBrowseMetadata(String collection,\n\tString categoryName, String lang, String[] nodeIDs, String[] metaNames)\nClassifierBrowseMetadataRetrieve service to retrieve some specific\nmetadata values of a document.\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - pages 47, 48\nParam collection: the name of the Collection whose\nClassifierBrowseMetadataRetrieve service is called\nParam categoryName: name of the browsing category, usually\nClassifierBrowse. (If left as \"\", then it defaults to ClassifierBrowse)\nParam lang: the language of the display content in the response\nParam nodeIDs: the list of document or classifier NodeIDs\nfor which the metadata ought to be retrieved.\nParam metaNames: a list of metadata names which are requested\nto be fetched for the specified documents or classifiers.\n
28
29browseDescendants=String browseDescendants(String collection,\n\tString browseService, String lang, String[] classifierNodeIDs)\nTo send a browse request for all the descendants of a classifier node.\nUseful for getting the entire structure of a top-level <classifierNode>\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - page 46\nParam collection: the name of the Collection whose browse Classifier\nBrowse Service is called\nParam browseService: the name of the (Classifier) Browse Service (of\nthe given collection) to which this request message is sent.\nParam lang: the language of the display content in the response\nParam classifierNodeIDs: an array of classifierNodeIDs for which the\nstructures ought to be retrieved.\n
30
31browse=String browse(String collection, String browseService,\n\tString lang, String[]classifierNodeIDs, String[] structureParams)\nTo send a browse request for specific parts of a classifier node\n(children, ancestors, descendants). Useful for getting specific parts\nof the structure of a top-level <classifierNode>.\nSee http://www.greenstone.org/docs/greenstone3/manual.pdf - page 46\nParam collection: the name of the Collection whose browse Classifier\nBrowse Service is called.\nParam browseService: the name of the (Classifier) Browse Service (of\nthe given collection) to which this request message is sent.\nParam lang: the language of the display content in the response\nParam classifierNodeIDs is the list of classifierNodeIDs for which the\nstructure ought to be retrieved.\nParam structureParams: the list of parameters indicating what structure\ninformation is requested. Accepted values are ancestors, parent,\nsiblings, children, descendants.\n
32
33help=String help()\nReturns a String containing help usage and the list of methods\nsupported by Greenstone 3's web services.\n
34
35helpWithMethod=String helpWithMethod(String methodName)\nReturns a String containing a description of the requested web\nservice method denoted by "methodName".\nParam methodName: the name of the web service operation for which\nthe help description string is to be returned.\n
Note: See TracBrowser for help on using the repository browser.