getGUIsByName

Gets the metadata headers of all the GUIs for a particular object type. This lightweight method is useful for making a quick call to retrieve the GUI name or ids for use with other methods. This call is identical to the getGUIs method, except it takes in the String names of ObjectType and module instead of the objectTypeId.

Parameters

objectTypeName
The name of the object type to be searched.
moduleName
The name of the module to be searched.

Returns

An array of GUI objects is returned.

Errors

ObjectTypeDoesNotExistException
The object specified by objectTypeName and moduleName do not exist.
InvalidArgumentException
The objectTypeName or moduleName is null or an empty string.
java.lang.Exception
A system error occurred when the request was being processed.

Sample request

<soapenv:Envelope 
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 	xmlns:ws="http://ws.tririga.com">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getGUIsByName>
         <ws:objectTypeName>Document</ws:objectTypeName>
         <ws:moduleName>Document</ws:moduleName>
      </ws:getGUIsByName>
   </soapenv:Body>
</soapenv:Envelope>

Sample response

<soap:Envelope 
	xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 	xmlns:xsd="http://www.w3.org/2001/XMLSchema" 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soap:Body>
      <getGUIsByNameResponse xmlns="http://ws.tririga.com">
         <out>
            <ns1:GUI xmlns:ns1="http://gui.dto.ws.tririga.com">
               <childRecordId xmlns="http://gui.dto.ws.tririga.com">0</childRecordId>
               <id xmlns="http://gui.dto.ws.tririga.com">106615</id>
               <label xmlns="http://gui.dto.ws.tririga.com">Document</label>
               <moduleId xmlns="http://gui.dto.ws.tririga.com">11</moduleId>
               <moduleName xmlns="http://gui.dto.ws.tririga.com">Document</moduleName>
               <name xmlns="http://gui.dto.ws.tririga.com">Document</name>
               <objectTypeId xmlns="http://gui.dto.ws.tririga.com">106615</objectTypeId>
               <objectTypeName xmlns="http://gui.dto.ws.tririga.com">Document</objectTypeName>
               <popupId xmlns="http://gui.dto.ws.tririga.com">0</popupId>
               <recordId xmlns="http://gui.dto.ws.tririga.com">0</recordId>
               <recordName xsi:nil="true" xmlns="http://gui.dto.ws.tririga.com"/>
               <saveOnPopup xmlns="http://gui.dto.ws.tririga.com">false</saveOnPopup>
               <singleTab xmlns="http://gui.dto.ws.tririga.com">false</singleTab>
               <state xsi:nil="true" xmlns="http://gui.dto.ws.tririga.com"/>
               <tabs xsi:nil="true" xmlns="http://gui.dto.ws.tririga.com"/>
               <type xmlns="http://gui.dto.ws.tririga.com">Wizard</type>
            </ns1:GUI>
         </out>
      </getGUIsByNameResponse>
   </soap:Body>
</soap:Envelope>