Ignore:
Timestamp:
2012-12-04T15:46:11+13:00 (11 years ago)
Author:
ak19
Message:

All backslash-n (newline) chars replaced with html break since that's what the interface_basic.properties file for English uses for newline.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • main/trunk/greenstone3/web/WEB-INF/classes/QBRWebServicesHelp.properties

    r15299 r26546  
    11#### Help properties file for Greenstone3's QBR web services
    22
    3 describe=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
     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 />
    44
    5 describeCollection=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
     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 />
    66
    7 describeServiceCluster=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
     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 />
    88
    9 describeCollectionService=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
     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 />
    1010
    11 describeService=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
     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 />
    1212
    13 query=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
     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 />
    1414
    15 retrieveDocumentContent=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
     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 />
    1616
    17 retrieveEntireDocumentStructure=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
     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 />
    1818
    19 retrieveDocumentStructure=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
     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 />
    2020
    21 retrieveAllDocumentMetadata=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
     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 />
    2222
    23 retrieveDocumentMetadata=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
     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 />
    2424
    25 retrieveAllBrowseMetadata=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
     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 />
    2626
    27 retrieveBrowseMetadata=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
     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 />
    2828
    29 browseDescendants=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
     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 />
    3030
    31 browse=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
     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 />
    3232
    33 help=String help()\nReturns a String containing help usage and the list of methods\nsupported by Greenstone 3's web services.\n
     33help=String help()<br />Returns a String containing help usage and the list of methods<br />supported by Greenstone 3's web services.<br />
    3434
    35 helpWithMethod=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
     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 TracChangeset for help on using the changeset viewer.