complexType "state"

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

XML Representation Summary

<...

xsd:string

isArchived

xsd:boolean : "false"

isPublished

xsd:boolean : "false"

isStart

xsd:boolean : "false"

name

xsd:string

Content:

description?, color?, image?, permissions, transitions?

</...>

Content Elements (5):

color (within state),

description (type xsd:string),

image (within state),

permissions (type statePermissions),

transitions (type transitions)

All Direct / Indirect Based Elements (1):

state (type state)

Known Usage Locations

As direct type of elements (1):

state (type state)

Annotation

A workflow state definition.

XML Source

<xsd:complexType name="state">

<xsd:annotation>

<xsd:documentation>A workflow state definition.</xsd:documentation>

</xsd:annotation>

<xsd:sequence>

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

<xsd:annotation>

<xsd:documentation>

The description of the state. May be a key for a
string to be translated by this workflow's string resources.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element minOccurs="0" name="color">

<xsd:annotation>

<xsd:documentation>

This element defines colors for this state.

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

<xsd:annotation>

<xsd:documentation>

This element defines strong color
for this state. Its value should be a HTML valid color
value.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

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

<xsd:annotation>

<xsd:documentation>

This element defines the strong
color for this state. Its value should be a HTML valid
color value.

<xsd:element minOccurs="0" name="image">

<xsd:annotation>

<xsd:documentation>

This element defines icon images for this state.

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

<xsd:annotation>

<xsd:documentation>

This element defines the small
icon image for this state. It should be a path
relative to the web application root.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

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

<xsd:annotation>

<xsd:documentation>

This element defines the large
icon image for this state. It should be a path
relative to the web application root.

<xsd:element name="permissions" type="statePermissions">

<xsd:annotation>

<xsd:documentation>

This element defines the roles that have
permission to access the contents in this state.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

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

<xsd:annotation>

<xsd:documentation>

This element defines the transitions available
for contents in this state.

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

<xsd:annotation>

<xsd:documentation>

The id of the state. Must be unique between all states
in this workflow.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

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

<xsd:annotation>

<xsd:documentation>

The display name of the state. May be a key for a string
to be translated by this workflow's string resources.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute default="false" name="isStart" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates if this state is the start state of the workflow.
The default value is false.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute default="false" name="isArchived" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates if this state stored archived contents.
When a published content ends its publication period, its state is changed to the
workflow's isArchived state that is directly reachable from its current state.
The default value is false.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute default="false" name="isPublished" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates if this state represents a published state.
Contents that are not in a published state may not be published.
The default value is false.

The id of the state. Must be unique between all states in this workflow.

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

XML Source

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

<xsd:annotation>

<xsd:documentation>

The id of the state. Must be unique between all states
in this workflow.

Indicates if this state stored archived contents. When a published content ends its publication period, its state is changed to the workflow's isArchived state that is directly reachable from its current state. The default value is false.

Type:	xsd:boolean
Use:	optional
Default:	"false"
Defined:	locally, within this complexType

XML Source

<xsd:attribute default="false" name="isArchived" type="xsd:boolean">

Indicates if this state represents a published state. Contents that are not in a published state may not be published. The default value is false.

Type:	xsd:boolean
Use:	optional
Default:	"false"
Defined:	locally, within this complexType

XML Source

<xsd:attribute default="false" name="isPublished" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates if this state represents a published state.
Contents that are not in a published state may not be published.
The default value is false.

Indicates if this state is the start state of the workflow. The default value is false.

Type:	xsd:boolean
Use:	optional
Default:	"false"
Defined:	locally, within this complexType

XML Source

<xsd:attribute default="false" name="isStart" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Indicates if this state is the start state of the workflow.
The default value is false.

The display name of the state. May be a key for a string to be translated by this workflow's string resources.

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

XML Source

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

<xsd:annotation>

<xsd:documentation>

The display name of the state. May be a key for a string
to be translated by this workflow's string resources.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

Content Element Detail

color

This element defines colors for this state.

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

description

The description of the state. May be a key for a string to be translated by this workflow's string resources.

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

XML Source

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

<xsd:annotation>

<xsd:documentation>

The description of the state. May be a key for a
string to be translated by this workflow's string resources.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

image

This element defines icon images for this state.

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

permissions

This element defines the roles that have permission to access the contents in this state.

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

XML Source

<xsd:element name="permissions" type="statePermissions">

<xsd:annotation>

<xsd:documentation>

This element defines the roles that have
permission to access the contents in this state.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

transitions

This element defines the transitions available for contents in this state.

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

XML Source

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

<xsd:annotation>

<xsd:documentation>

This element defines the transitions available
for contents in this state.

</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