complexType "response"
Namespace:
Content:
complex, 3 attributes, 5 elements
Defined:
Includes:
definitions of 1 attribute and 5 elements
Used:
XML Representation Summary
<...
   
message
 = 
xsd:string
   
name
 = 
xsd:string
   
type
 = 
("parameterValue" | "attributeValue")
   
>
   
Content: 
</...>
Content Elements (5):
destPageId (type xsd:string),
interfaceId (type xsd:string),
script (type xsd:string),
url (type xsd:string)
All Direct / Indirect Based Elements (1):
Known Usage Locations
XML Source
<xsd:complexType name="response">
<xsd:sequence maxOccurs="1" minOccurs="0">
<xsd:element minOccurs="0" name="script" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Must be specified if the type of the response is doui_runJavascript.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="interfaceId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the response type is doui_hyperLink. Identifies the interface id (id may be relative to the current service) of the destination interface that the user must be taken to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="destPageId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the response type is doui_popupInterface. Identifies the pageId that the popup will be opened in. If specified this value usually is LumisBlankPage.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="url" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the response type is doui_hyperLink. Specifies the url that the user must be redirected to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="parameters">
<xsd:complexType>
<xsd:sequence maxOccurs="unbounded" minOccurs="0">
<xsd:element maxOccurs="unbounded" minOccurs="0" name="parameter">
<xsd:annotation>
<xsd:documentation>
Used when the response type is
<xhtml:b>doui_setResponseParameters</xhtml:b>
or
<xhtml:b>doui_hyperLink</xhtml:b>
. Each parameter node represents a response parameter name/value pair. If no value node is specified, the text value of this node is used as the parameter value.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value">
<xsd:annotation>
<xsd:documentation>
value of the parameter. If not specified the text value of the parameter node is used.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="type">
<xsd:annotation>
<xsd:documentation>
If not specified, the value is considered the text value of the value node.
<xhtml:br/>
If specified, the possible values are
<xhtml:br/>
<xhtml:br/>
<xhtml:b>parameterValue</xhtml:b>
: the value is taken from the request parameters passed to the process action. The text value of the value node represents the parameter name.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>attributeValue</xhtml:b>
: the value is taken from the current request attributes. The text value of the value node represents the attribute name.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="parameterValue"/>
<xsd:enumeration value="attributeValue"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>name of the parameter</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="type" type="responseType" use="required">
<xsd:annotation>
<xsd:documentation>
Possible response types.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_closeWindow</xhtml:b>
: Closes the current window.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_hyperLink</xhtml:b>
: Used to redirect the browser to another page / url after the process action. In addition parameters may be passed to the destination page.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_message</xhtml:b>
: Displays a message to the end user. This type requires a
<xhtml:b>message</xhtml:b>
attribute to be specified. This message will be translated to the users current language.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_popupInterface</xhtml:b>
: Used to popup an interface after the process action. In addition parameters may be passed to the popped up interface.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_preview</xhtml:b>
: Displays another window with the preview of the data being edited.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_refreshParent</xhtml:b>
: Refreshes the parent window.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_runJavascript</xhtml:b>
: Runs the javascript specified in the
<xhtml:b>script</xhtml:b>
node within the reponse.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_setRequestAttributes</xhtml:b>
: Used primarily to share data between different process actions. Sets parameter values in the request attributes. These attributes may be read by subsequent process actions with the same id.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_setRequestParameters</xhtml:b>
: Sets all the current parameters values to the following render request to the current interface.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_setResponseParameters</xhtml:b>
: Sets the specified parameters to the following render request to the current interface.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_standardCommit</xhtml:b>
: Used in standard add and edit administration interfaces. This response detects whether the current interface is a popup or an embedded interface. If popup, this response is equivalent to a doui_refreshParent response followed by a doui_closeWindow response. If embedded, this response detects where the administration list interface is located and redirects the portal to the page that contains that interface.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_standardEmbedded</xhtml:b>
: Used in interfaces that are embedded within portal pages. This is equivalent to a doui_setRequestParameters response.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_standardPopup</xhtml:b>
: Used interfaces that are within popup windows. This internally is converted to two responses. One doui_refreshParent response followed by one doui_closeWindow response.
<xhtml:br/>
<xhtml:br/>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="message" type="xsd:string"/>
</xsd:complexType>
Attribute Detail (defined in this component only)
message
Type:
xsd:string
Use:
optional
Defined:
locally, within this complexType
XML Source
<xsd:attribute name="message" type="xsd:string"/>
Content Element Detail
destPageId
Used when the response type is doui_popupInterface. Identifies the pageId that the popup will be opened in. If specified this value usually is LumisBlankPage.
Type:
xsd:string, simple content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="destPageId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the response type is doui_popupInterface. Identifies the pageId that the popup will be opened in. If specified this value usually is LumisBlankPage.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

interfaceId
Used when the response type is doui_hyperLink. Identifies the interface id (id may be relative to the current service) of the destination interface that the user must be taken to.
Type:
xsd:string, simple content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="interfaceId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the response type is doui_hyperLink. Identifies the interface id (id may be relative to the current service) of the destination interface that the user must be taken to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

parameters
Type:
embedded, complex content
Defined:
locally, within this complexType

script
Must be specified if the type of the response is doui_runJavascript.
Type:
xsd:string, simple content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="script" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Must be specified if the type of the response is doui_runJavascript.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

url
Used when the response type is doui_hyperLink. Specifies the url that the user must be redirected to.
Type:
xsd:string, simple content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="url" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the response type is doui_hyperLink. Specifies the url that the user must be redirected to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

XML Schema documentation generated with DocFlex/XML (Kit) v1.6.2
DocFlex/XML is a powerful template-driven documentation and report generator from any data stored in XML files. Based on an innovative technology developed by FILIGRIS WORKS, this new tool offers virtuoso data querying and formatting capabilities not found in anything else!
Need to convert your XML data into a clear nice-looking documentation or reports? Web-ready hypertext HTML or printable MS Word / OpenOffice.org friendly RTF? DocFlex/XML may be a cheap, quick and effective solution exactly for this task!
Have questions? Not sure how to use it? Just send us e-mail to contact@filigris.com and we are always happy to help you! See also our services at www.filigris.com

Lumisportal  14.0.1.210806 - Copyright © 2006–2021 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.