Changeset 5126 for trunk/gsdl3/src/java/org/greenstone/gsdl3/service/GS2Construct.java

Timestamp:

2003-08-13T09:54:20+12:00 (21 years ago)

Author:

kjdon

Message:

describe requests to services can now take a parameter 'subset' just like any other describe requests. choices are paramList and displayItem. so you can just get the display text without having to go through and create all teh parameters

File:

• trunk/gsdl3/src/java/org/greenstone/gsdl3/service/GS2Construct.java (modified) (1 diff)

trunk/gsdl3/src/java/org/greenstone/gsdl3/service/GS2Construct.java

@@ -78 +78 @@
 
     /** returns a specific service description */
-    protected Element getServiceDescription(String service, String lang) {
+    protected Element getServiceDescription(String service, String lang, String subset) {
 
     Element description = this.doc.createElement(GSXML.SERVICE_ELEM);
     description.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_PROCESS);
     description.setAttribute(GSXML.NAME_ATT, service);
-    description.appendChild(GSXML.createDisplayTextElement(this.doc, GSXML.DISPLAY_TEXT_NAME,  getTextString(service+".name", lang)));
-    description.appendChild(GSXML.createDisplayTextElement(this.doc, GSXML.DISPLAY_TEXT_DESCRIPTION,  getTextString(service+".description", lang)));
-    description.appendChild(GSXML.createDisplayTextElement(this.doc,  GSXML.DISPLAY_TEXT_SUBMIT, getTextString(service+".submit", lang)));
-
-    Element param_list = this.doc.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
-    description.appendChild(param_list);
-    
-    if (service.equals(NEW_SERVICE)) {
+    if (subset == null || subset.equals(GSXML.DISPLAY_TEXT_ELEM)) {
+        description.appendChild(GSXML.createDisplayTextElement(this.doc, GSXML.DISPLAY_TEXT_NAME,  getTextString(service+".name", lang)));
+        description.appendChild(GSXML.createDisplayTextElement(this.doc, GSXML.DISPLAY_TEXT_DESCRIPTION,  getTextString(service+".description", lang)));
+        description.appendChild(GSXML.createDisplayTextElement(this.doc,  GSXML.DISPLAY_TEXT_SUBMIT, getTextString(service+".submit", lang)));
+    }
+    if (subset == null || subset.equals(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER)) {
+        Element param_list = this.doc.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
+        description.appendChild(param_list);
         
-        Element param = GSXML.createParameterDescription(this.doc, NEW_COL_TITLE_PARAM, getTextString("param."+NEW_COL_TITLE_PARAM, lang), GSXML.PARAM_TYPE_STRING, null, null, null);
-        param_list.appendChild(param);
-        param = GSXML.createParameterDescription(this.doc, CREATOR_PARAM, getTextString("param."+CREATOR_PARAM, lang), GSXML.PARAM_TYPE_STRING, null, null, null);
-        param_list.appendChild(param);
-        param = GSXML.createParameterDescription(this.doc, NEW_COL_ABOUT_PARAM, getTextString("param."+NEW_COL_ABOUT_PARAM, lang), GSXML.PARAM_TYPE_TEXT, null, null, null);
-        param_list.appendChild(param);
-        String[] types = {BUILDTYPE_MGPP, BUILDTYPE_MG};
-        String[] type_texts = {getTextString("param."+BUILDTYPE_PARAM+"."+BUILDTYPE_MGPP, lang), getTextString("param."+BUILDTYPE_PARAM+"."+BUILDTYPE_MG, lang)};
+        if (service.equals(NEW_SERVICE)) {
+        
+        Element param = GSXML.createParameterDescription(this.doc, NEW_COL_TITLE_PARAM, getTextString("param."+NEW_COL_TITLE_PARAM, lang), GSXML.PARAM_TYPE_STRING, null, null, null);
+        param_list.appendChild(param);
+        param = GSXML.createParameterDescription(this.doc, CREATOR_PARAM, getTextString("param."+CREATOR_PARAM, lang), GSXML.PARAM_TYPE_STRING, null, null, null);
+        param_list.appendChild(param);
+        param = GSXML.createParameterDescription(this.doc, NEW_COL_ABOUT_PARAM, getTextString("param."+NEW_COL_ABOUT_PARAM, lang), GSXML.PARAM_TYPE_TEXT, null, null, null);
+        param_list.appendChild(param);
+        String[] types = {BUILDTYPE_MGPP, BUILDTYPE_MG};
+        String[] type_texts = {getTextString("param."+BUILDTYPE_PARAM+"."+BUILDTYPE_MGPP, lang), getTextString("param."+BUILDTYPE_PARAM+"."+BUILDTYPE_MG, lang)};
+        
+        param = GSXML.createParameterDescription(this.doc, BUILDTYPE_PARAM, getTextString("param."+BUILDTYPE_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, BUILDTYPE_MGPP, types, type_texts);
+        param_list.appendChild(param);
+        }
+        else if (service.equals(ACTIVATE_SERVICE) || service.equals(IMPORT_SERVICE) || service.equals(BUILD_SERVICE) || service.equals(RELOAD_SERVICE) || service.equals(DELETE_SERVICE)) {
         
-        param = GSXML.createParameterDescription(this.doc, BUILDTYPE_PARAM, getTextString("param."+BUILDTYPE_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, BUILDTYPE_MGPP, types, type_texts);
-        param_list.appendChild(param);
-        return description;
-    }
-    
-    
-    if (service.equals(ACTIVATE_SERVICE) || service.equals(IMPORT_SERVICE) || service.equals(BUILD_SERVICE) || service.equals(RELOAD_SERVICE) || service.equals(DELETE_SERVICE)) {
-        
-        this.collection_list = getCollectionList();
-        Element param = GSXML.createParameterDescription(this.doc, COL_PARAM, getTextString("param."+COL_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, null, this.collection_list, this.collection_list); 
-        param_list.appendChild(param);
-        
-        return description;
-    }
-    // invalid service name
-    return null;
-    
+        this.collection_list = getCollectionList();
+        Element param = GSXML.createParameterDescription(this.doc, COL_PARAM, getTextString("param."+COL_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, null, this.collection_list, this.collection_list); 
+        param_list.appendChild(param);
+        } else {
+        // invalid service name
+        return null;
+        }
+    }
+    return description;
     }