complexType "interface"

Namespace:	<global>
Content:	complex, 5 attributes, 30 elements
Defined:	globally in servicedefinition.xsd, see XML source
Includes:	definitions of 5 attributes and 30 elements
Used:	at 1 location

XML Representation Summary

<...

className

xsd:string

name

xsd:string

scriptPath

xsd:string

type

Content:

description? × title? × isRuntimeOnly? × usesSocialProfileInformation? × serviceInstanceRequired? × callerServiceInterfaceMenuItemRequired? × isAdministration? × isPrintable? × isOpenerWindowRequired? × renderAs? × width? × height? × paddingLeft? × paddingRight? × paddingTop? × paddingBottom? × popupWindowProperties? × styles? × cache? × menu? × isDetails? × isList? × isSummary? × previewSupported? × permissions? × modes? × isWidget? × isRestEnabled? × inContextEditSupported? × automaticAdministration?

</...>

Content Elements (30):

automaticAdministration (type xsd:boolean),

cache (type cache),

callerServiceInterfaceMenuItemRequired (type xsd:boolean),

description (type xsd:string),

height (type xsd:nonNegativeInteger),

inContextEditSupported (type xsd:boolean),

isAdministration (type xsd:boolean),

isDetails (type xsd:boolean),

isList (type xsd:boolean),

isOpenerWindowRequired (type xsd:boolean),

isPrintable (type xsd:boolean),

isRestEnabled (type xsd:boolean),

isRuntimeOnly (type xsd:boolean),

isSummary (type xsd:boolean),

isWidget (type xsd:boolean),

menu (type menu),

modes (type interfaceModes),

paddingBottom (type xsd:nonNegativeInteger),

paddingLeft (type xsd:nonNegativeInteger),

paddingRight (type xsd:nonNegativeInteger),

paddingTop (type xsd:nonNegativeInteger),

permissions (type interfacePermissions),

popupWindowProperties (type xsd:string),

previewSupported (type xsd:boolean),

renderAs (type renderAsTypes),

serviceInstanceRequired (type xsd:boolean),

styles (type styles),

title (type xsd:string),

usesSocialProfileInformation (type xsd:boolean),

width (type xsd:nonNegativeInteger)

All Direct / Indirect Based Elements (1):

interface (type interface)

Known Usage Locations

As direct type of elements (1):

interface (type interface)

XML Source

<xsd:complexType name="interface">

<xsd:all>

<xsd:element minOccurs="0" name="description" type="xsd:string"/>

<xsd:element minOccurs="0" name="title" type="xsd:string"/>

<xsd:element minOccurs="0" name="isRuntimeOnly" type="xsd:boolean"/>

<xsd:element default="false" maxOccurs="1" minOccurs="0" name="usesSocialProfileInformation" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates whether this intefaces uses information about users' social profile.
If this configuration is set to true, the renderization of DOUI LumisPrincipal type fields will contain
the corresponding social profile information.
The default value is false.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element default="true" minOccurs="0" name="serviceInstanceRequired" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

If this configuration is set to true, the portal will require a service instance of the same service of the
interface to render it.
If this configuration is set to false, the portal will not require a service instance to render it.
In this case, the portal will not validate the user permissions in a service instance. If some validation
should be made, the interface should do it itself.
The default value is true.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element default="false" minOccurs="0" name="callerServiceInterfaceMenuItemRequired" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

If this configuration is set to true, instances of this interface may only be executed when
the caller service interface menu item is identified in the request. It will be required
that the current user has been granted a permission defined in the menu item for the request
to be processed.
The default value is false.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element minOccurs="0" name="isAdministration" type="xsd:boolean"/>

<xsd:element minOccurs="0" name="isPrintable" type="xsd:boolean"/>

<xsd:element default="true" minOccurs="0" name="isOpenerWindowRequired" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

This configuration indicates whether an opener window is expected to exist for the correct working of this interface.
When this configuration is set to

<xhtml:i>true</xhtml:i>

the portal will try to open this interface, when requested to, in such way that the opener window remain active.
Otherwise, the portal may choose to open this interface in such way the opener window may not remain active.
By default, this configuration is set to

<xhtml:i>true</xhtml:i>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element minOccurs="0" name="renderAs" type="renderAsTypes"/>

<xsd:element minOccurs="0" name="width" type="xsd:nonNegativeInteger"/>

<xsd:element minOccurs="0" name="height" type="xsd:nonNegativeInteger"/>

<xsd:element minOccurs="0" name="paddingLeft" type="xsd:nonNegativeInteger"/>

<xsd:element minOccurs="0" name="paddingRight" type="xsd:nonNegativeInteger"/>

<xsd:element minOccurs="0" name="paddingTop" type="xsd:nonNegativeInteger"/>

<xsd:element minOccurs="0" name="paddingBottom" type="xsd:nonNegativeInteger"/>

<xsd:element minOccurs="0" name="popupWindowProperties" type="xsd:string"/>

<xsd:element minOccurs="0" name="styles" type="styles">

<xsd:annotation>

<xsd:documentation>

Indicates whether this interface's will have one or more styles pre-registered.
If this tag is not inserted, the system will try to resolve the default interface style based
on interface identifier, it will search inside service folders for a 'style' folder,
then will search for style archives (*.xsl, *.js, *.groovy) named by interface identifier,
if any were found, will use it as interface default style.

<xhtml:p>Example:</xhtml:p>

<pre>

</styles>

</interface>

Default style will be "List.js".

</interface>

Default style will be the LumisXP generic style.

</interface>

Default style, if found in "style" folder inside service folder, will be "list.xsl", "list.js" or "list.groovy".
If no such file exists, the LumisXP generic style will be used as default.

<xsd:element minOccurs="0" name="cache" type="cache"/>

<xsd:element minOccurs="0" name="menu" type="menu"/>

<xsd:element minOccurs="0" name="isDetails" type="xsd:boolean"/>

<xsd:element minOccurs="0" name="isList" type="xsd:boolean"/>

<xsd:element minOccurs="0" name="isSummary" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates whether this interface's main purpose is to display a summary
of the data related to it. By default, it is true for quick lists and false for other interface types.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element minOccurs="0" name="previewSupported" type="xsd:boolean"/>

<xsd:element minOccurs="0" name="permissions" type="interfacePermissions"/>

<xsd:element minOccurs="0" name="modes" type="interfaceModes">

<xsd:annotation>

<xsd:documentation>Lists the modes this interface supports.</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element minOccurs="0" name="isWidget" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates whether this interface may be used as a widget in a personalized page.
By default, it is true for interfaces that are not runtime.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element minOccurs="0" name="isRestEnabled" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates that will be generated automatically a rest interface for the interface.
By default, it is true for lists and details interfaces and false for other interface types.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element default="true" minOccurs="0" name="inContextEditSupported" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates whether this interface supports the in-context edit feature. This attribute is to be
set to false if this interface is not compatible with portal the in-context edit feature.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element maxOccurs="1" minOccurs="0" name="automaticAdministration" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates whether the current service interface
is displayed by the auto administration service. If an interface
is considered relevant to the auto administration service, it will
be created at runtime when there is an area with the auto
administration service instantiated. If this node is not present,
the default behavior will be to consider it true if the interface
is not runtime and is an administration list interface, false otherwise.

<xsd:attribute name="id" type="xsd:string" use="required"/>

<xsd:attribute name="name" type="xsd:string" use="required"/>

<xsd:attribute name="className" type="xsd:string" use="optional">

<xsd:annotation>

<xsd:documentation>

The class name of the IServiceInterface implementation used for this service.
This attribute cannot be defined if the "scriptPath" attribute is defined.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="scriptPath" type="xsd:string" use="optional">

<xsd:annotation>

<xsd:documentation>

Path of a script defining the java class that implements IServiceInterface used for this service interface.
This attribute cannot be defined if the "className" attribute is defined.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="type" type="serviceInterfaceType" use="optional"/>

</xsd:complexType>

Attribute Detail

className

The class name of the IServiceInterface implementation used for this service. This attribute cannot be defined if the "scriptPath" attribute is defined.

Type:	xsd:string
Use:	optional
Defined:	locally, within this complexType

XML Source

<xsd:attribute name="className" type="xsd:string" use="optional">

<xsd:annotation>

<xsd:documentation>

The class name of the IServiceInterface implementation used for this service.
This attribute cannot be defined if the "scriptPath" attribute is defined.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

Type:	xsd:string
Use:	required
Defined:	locally, within this complexType

XML Source

<xsd:attribute name="id" type="xsd:string" use="required"/>

name

Type:	xsd:string
Use:	required
Defined:	locally, within this complexType

XML Source

<xsd:attribute name="name" type="xsd:string" use="required"/>

scriptPath

Path of a script defining the java class that implements IServiceInterface used for this service interface. This attribute cannot be defined if the "className" attribute is defined.

Type:	xsd:string
Use:	optional
Defined:	locally, within this complexType

XML Source

<xsd:attribute name="scriptPath" type="xsd:string" use="optional">

<xsd:annotation>

<xsd:documentation>

Path of a script defining the java class that implements IServiceInterface used for this service interface.
This attribute cannot be defined if the "className" attribute is defined.

Type:	serviceInterfaceType
Use:	optional
Defined:	locally, within this complexType

XML Source

<xsd:attribute name="type" type="serviceInterfaceType" use="optional"/>

Content Element Detail

automaticAdministration

Indicates whether the current service interface is displayed by the auto administration service. If an interface is considered relevant to the auto administration service, it will be created at runtime when there is an area with the auto administration service instantiated. If this node is not present, the default behavior will be to consider it true if the interface is not runtime and is an administration list interface, false otherwise.

Type:	xsd:boolean, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element maxOccurs="1" minOccurs="0" name="automaticAdministration" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

cache

Type:	cache, complex content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="cache" type="cache"/>

callerServiceInterfaceMenuItemRequired

If this configuration is set to true, instances of this interface may only be executed when the caller service interface menu item is identified in the request. It will be required that the current user has been granted a permission defined in the menu item for the request to be processed. The default value is false.

Type:	xsd:boolean, simple content
Default:	"false"
Defined:	locally, within this complexType

XML Source

<xsd:element default="false" minOccurs="0" name="callerServiceInterfaceMenuItemRequired" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

description

Type:	xsd:string, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="description" type="xsd:string"/>

height

Type:	xsd:nonNegativeInteger, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="height" type="xsd:nonNegativeInteger"/>

inContextEditSupported

Indicates whether this interface supports the in-context edit feature. This attribute is to be set to false if this interface is not compatible with portal the in-context edit feature.

Type:	xsd:boolean, simple content
Default:	"true"
Defined:	locally, within this complexType

XML Source

<xsd:element default="true" minOccurs="0" name="inContextEditSupported" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates whether this interface supports the in-context edit feature. This attribute is to be
set to false if this interface is not compatible with portal the in-context edit feature.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

isAdministration

Type:	xsd:boolean, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="isAdministration" type="xsd:boolean"/>

isDetails

Type:	xsd:boolean, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="isDetails" type="xsd:boolean"/>

isList

Type:	xsd:boolean, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="isList" type="xsd:boolean"/>

isOpenerWindowRequired

This configuration indicates whether an opener window is expected to exist for the correct working of this interface. When this configuration is set to true the portal will try to open this interface, when requested to, in such way that the opener window remain active. Otherwise, the portal may choose to open this interface in such way the opener window may not remain active. By default, this configuration is set to true.

Type:	xsd:boolean, simple content
Default:	"true"
Defined:	locally, within this complexType

XML Source

<xsd:element default="true" minOccurs="0" name="isOpenerWindowRequired" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

This configuration indicates whether an opener window is expected to exist for the correct working of this interface.
When this configuration is set to

<xhtml:i>true</xhtml:i>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

isPrintable

Type:	xsd:boolean, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="isPrintable" type="xsd:boolean"/>

isRestEnabled

Indicates that will be generated automatically a rest interface for the interface. By default, it is true for lists and details interfaces and false for other interface types.

Type:	xsd:boolean, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="isRestEnabled" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates that will be generated automatically a rest interface for the interface.
By default, it is true for lists and details interfaces and false for other interface types.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

isRuntimeOnly

Type:	xsd:boolean, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="isRuntimeOnly" type="xsd:boolean"/>

isSummary

Indicates whether this interface's main purpose is to display a summary of the data related to it. By default, it is true for quick lists and false for other interface types.

Type:	xsd:boolean, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="isSummary" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates whether this interface's main purpose is to display a summary
of the data related to it. By default, it is true for quick lists and false for other interface types.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

isWidget

Indicates whether this interface may be used as a widget in a personalized page. By default, it is true for interfaces that are not runtime.

Type:	xsd:boolean, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="isWidget" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates whether this interface may be used as a widget in a personalized page.
By default, it is true for interfaces that are not runtime.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

Type:	menu, complex content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="menu" type="menu"/>

modes

Lists the modes this interface supports.

Type:	interfaceModes, complex content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="modes" type="interfaceModes">

<xsd:annotation>

<xsd:documentation>Lists the modes this interface supports.</xsd:documentation>

</xsd:annotation>

</xsd:element>

paddingBottom

Type:	xsd:nonNegativeInteger, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="paddingBottom" type="xsd:nonNegativeInteger"/>

paddingLeft

Type:	xsd:nonNegativeInteger, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="paddingLeft" type="xsd:nonNegativeInteger"/>

paddingRight

Type:	xsd:nonNegativeInteger, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="paddingRight" type="xsd:nonNegativeInteger"/>

paddingTop

Type:	xsd:nonNegativeInteger, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="paddingTop" type="xsd:nonNegativeInteger"/>

permissions

Type:	interfacePermissions, complex content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="permissions" type="interfacePermissions"/>

popupWindowProperties

Type:	xsd:string, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="popupWindowProperties" type="xsd:string"/>

previewSupported

Type:	xsd:boolean, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="previewSupported" type="xsd:boolean"/>

renderAs

Type:	renderAsTypes, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="renderAs" type="renderAsTypes"/>

serviceInstanceRequired

If this configuration is set to true, the portal will require a service instance of the same service of the interface to render it. If this configuration is set to false, the portal will not require a service instance to render it. In this case, the portal will not validate the user permissions in a service instance. If some validation should be made, the interface should do it itself. The default value is true.

Type:	xsd:boolean, simple content
Default:	"true"
Defined:	locally, within this complexType

XML Source

<xsd:element default="true" minOccurs="0" name="serviceInstanceRequired" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

styles

Indicates whether this interface's will have one or more styles pre-registered. If this tag is not inserted, the system will try to resolve the default interface style based on interface identifier, it will search inside service folders for a 'style' folder, then will search for style archives (*.xsl, *.js, *.groovy) named by interface identifier, if any were found, will use it as interface default style.

Example:

<pre> <interface id="list" name="STR_LIST" type="lum_douiList"> <styles> <style id="list" name="STR_LIST" path="style/List.js"/> </styles> </interface> Default style will be "List.js". <interface id="list" name="STR_LIST" type="lum_douiList"> <styles/> </interface> Default style will be the LumisXP generic style. <interface id="list" name="STR_LIST" type="lum_douiList"> </interface> Default style, if found in "style" folder inside service folder, will be "list.xsl", "list.js" or "list.groovy". If no such file exists, the LumisXP generic style will be used as default. </pre>

Type:	styles, complex content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="styles" type="styles">

<xsd:annotation>

<xsd:documentation>

<xhtml:p>Example:</xhtml:p>

<pre>

</styles>

</interface>

Default style will be "List.js".

</interface>

Default style will be the LumisXP generic style.

</interface>

Default style, if found in "style" folder inside service folder, will be "list.xsl", "list.js" or "list.groovy".
If no such file exists, the LumisXP generic style will be used as default.

</pre>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

title

Type:	xsd:string, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="title" type="xsd:string"/>

usesSocialProfileInformation

Indicates whether this intefaces uses information about users' social profile. If this configuration is set to true, the renderization of DOUI LumisPrincipal type fields will contain the corresponding social profile information. The default value is false.

Type:	xsd:boolean, simple content
Default:	"false"
Defined:	locally, within this complexType

XML Source

<xsd:element default="false" maxOccurs="1" minOccurs="0" name="usesSocialProfileInformation" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

width

Type:	xsd:nonNegativeInteger, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="width" type="xsd:nonNegativeInteger"/>

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