element <tns:entitlement> (local)

Namespace:	http://midpoint.evolveum.com/xml/ns/public/common/common-1.xsd
Type:	tns:EntitlementConstructionType
Content:	complex, 4 attributes, 10 elements
Defined:	locally witnin tns:AccountConstructionType complexType in common-1.xsd; see XML source

XML Representation Summary

<tns:entitlement

authoritative	=	xsd:boolean : "true"
clear	=	xsd:boolean : "false"
default	=	xsd:boolean : "false"
exclusive	=	xsd:boolean : "false"

Content:

tns:description?, tns:extension?, (tns:value | (tns:variable*, tns:valueExpression, tns:dependency*)), tns:condition?, tns:valueFilter*, (tns:type? | tns:typeExpression?)

</tns:entitlement>

Content model elements (10):

tns:condition, tns:dependency (type tns:XPathType), tns:description, tns:extension, tns:type (type xsd:string), tns:typeExpression (type tns:ExpressionType), tns:value (defined in tns:ValueConstructionType complexType), tns:valueExpression (type tns:ExpressionType), tns:valueFilter, tns:variable (type tns:VariableDefinitionType)

Included in content model of elements (1):

tns:accountConstruction (type tns:AccountConstructionType)

Annotation

Assignments implied by this role. When the role is assigned the assignable types (groups, native roles) specified below should be assigned to the account. When the role is unassigned, the assignable types specified below should be unassigned unless some other role is still specifying them. TODO: this is very simplistic now. Later we need flags for value removal, authoritativeness, merging approach, etc.

XML Source (see within schema source)

<xsd:element maxOccurs="unbounded" minOccurs="0" name="entitlement" type="tns:EntitlementConstructionType">

<xsd:annotation>

<xsd:documentation>

Assignments implied by this role.
When the role
is assigned the
assignable types (groups, native
roles)
specified
below should
be assigned to the account.

When the role is
unassigned, the
assignable types specified
below
should be
unassigned
unless some
other role is still specifying them.

TODO: this is very
simplistic now.
Later
we need flags for value
removal,
authoritativeness, merging
approach, etc.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

Attribute Detail (all declarations; 4/4)

authoritative

Type:	xsd:boolean
Use:	optional
Default:	"true"
Defined:	locally within tns:ValueConstructionType complexType

The value provided by this construction element is authoritative. It means that this value construction is supposed to both add the value and remove it. TODO: not yet finished

XML Source (see within schema source)

<xsd:attribute default="true" name="authoritative" type="xsd:boolean" use="optional">

<xsd:annotation>

<xsd:documentation>

The value provided by this construction element
is authoritative.

It means that this value
construction is
supposed
to both
add the value and remove it.

TODO: not yet finished

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

clear

Type:	xsd:boolean
Use:	optional
Default:	"false"
Defined:	locally within tns:ValueConstructionType complexType

The value construction is supposed to be executed on the "clear" value for a attribute or property. If there are any existing values on the property or attribute before the execution of all applicable value construction definitions, such values should be cleared. TODO: not yet finished

XML Source (see within schema source)

<xsd:attribute default="false" name="clear" type="xsd:boolean" use="optional">

<xsd:annotation>

<xsd:documentation>

The value construction is supposed to be executed
on the
"clear" value for a attribute or
property.

If there
are any
existing values on the property or attribute
before the execution of
all applicable value
construction
definitions, such
values should be
cleared.

TODO: not yet finished

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

default

Type:	xsd:boolean
Use:	optional
Default:	"false"
Defined:	locally within tns:ValueConstructionType complexType

This value construction should only be applied if the property or attribute does not have a value. This flag makes the value construction conditional. Please note that now there is no way how to get attribute value and set a new value atomically. Therefore also the "default" flag cannot be executed atomically and a risk of inconsistency is still there. The implementation should minimize that risk by making the "window of risk" as shortas possible and utilize any additional consistency guarantees if possible.

XML Source (see within schema source)

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

<xsd:annotation>

<xsd:documentation>

This value construction should only be applied if the
property or attribute does not have a value.

This flag makes the value construction conditional. Please
note that now there is no way how to get attribute value and
set a new value atomically. Therefore also the "default" flag
cannot be executed atomically and a risk of inconsistency is
still there. The implementation should minimize that risk by
making the "window of risk" as shortas possible and utilize
any additional consistency guarantees if possible.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

exclusive

Type:	xsd:boolean
Use:	optional
Default:	"false"
Defined:	locally within tns:ValueConstructionType complexType

The value construction cannot be combined with other value constructions. If there are other non-exclusive value constructions to be applied to the same propert or attribute, such constructions should be ignored. If there are other exclusive value constructions, the error should be produced and the values should not be changed. TODO: not yet finished

XML Source (see within schema source)

<xsd:attribute default="false" name="exclusive" type="xsd:boolean" use="optional">

<xsd:annotation>

<xsd:documentation>

The value construction cannot be combined with
other
value constructions.

If there are other
non-exclusive
value
constructions to be
applied to the same propert or attribute, such
constructions
should be
ignored. If there are other
exclusive value
constructions, the error should be produced and the values
should
not be
changed.

TODO: not yet finished

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

Content Element Detail (all declarations; 10/10)

tns:condition

Type:	tns:ExpressionType, complex content
Defined:	by reference within tns:ValueConstructionType complexType

The value will only be valid if the condition is evaluated to true. If the condition is false, the value definition should not be applied at all (exactly as if there is no definition). If there is no condition, it is assumed to be true.

XML Source (see within schema source)

<xsd:element minOccurs="0" ref="c:condition">

<xsd:annotation>

<xsd:documentation>

The value will only be valid if the condition is
evaluated to true. If the condition is false,
the value
definition
should not be applied at all (exactly as if
there is no
definition).
If there is no condition,
it is assumed to be
true.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

tns:dependency

Type:	tns:XPathType, mixed content
Defined:	locally within tns:ValueConstructionType complexType

Defines the XPath of a property on which the expression depends. If there are other expressions to be evaluated that set such value, such expressions will be evaluated before this expression. This may or may not be needed. If the dependencies can be derived from the expression implicitly, the dependency element may be omitted. It may also be omitted if the order of expression execution is not significant. In case the user want to make sure that expressions will be executed in a crertain order, he should include dependency elements. Due to the JAXB "feature" this does not work for now. Please do not use it.

XML Source (see within schema source)

<xsd:element maxOccurs="unbounded" minOccurs="0" name="dependency" type="c:XPathType">

<xsd:annotation>

<xsd:documentation>

Defines the XPath of a property on which the
expression
depends. If there are other expressions
to be
evaluated
that set such value, such expressions will
be evaluated before
this expression.

This may or may not
be needed. If
the
dependencies
can be derived from the expression implicitly, the
dependency element may be
omitted. It may also be
omitted if the
order of expression execution is not
significant. In case the
user want to
make sure that
expressions will be
executed in a
crertain order, he
should include dependency elements.

Due to the
JAXB "feature" this does not work for now.
Please do not use it.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

tns:description

Type:	xsd:string, simple content
Defined:	by reference within tns:ValueConstructionType complexType

XML Source (see within schema source)

<xsd:element maxOccurs="1" minOccurs="0" ref="tns:description"/>

tns:extension

Type:	anonymous complexType, complex content
Defined:	by reference within tns:ValueConstructionType complexType

XML Source (see within schema source)

<xsd:element maxOccurs="1" minOccurs="0" ref="c:extension"/>

tns:type

Type:	xsd:string, simple content
Defined:	locally within tns:EntitlementConstructionType complexType

Type of entitlement that should be created on the resource. This must point to the a valid entitlementType definition in the resource object (in schemaHandling section). This element is optional. If not specified then the entitlement type marked as default in the resource definition should be used.

XML Source (see within schema source)

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

<xsd:annotation>

<xsd:documentation>

Type of entitlement that should be created on
the resource.

This must point to the a valid
entitlementType
definition in the resource
object (in schemaHandling section).

This element is optional. If not
specified
then the entitlement
type
marked as default in the resource
definition should be used.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

tns:typeExpression

Type:	tns:ExpressionType, complex content
Defined:	locally within tns:EntitlementConstructionType complexType

Expression that determines type of account that should be created on the resource. TODO The variables should be set as follows: $account - the account that this entitlement will be part of $user - the user that such account will belong to $assignment - an assignemt that is assigning the object in which context is this expression evaluated (e.g. assignment of role)

XML Source (see within schema source)

<xsd:element minOccurs="0" name="typeExpression" type="c:ExpressionType">

<xsd:annotation>

<xsd:documentation>

Expression that determines type of account
that
should be created on the resource.
TODO

The
variables
should be
set as follows:
$account - the account that this entitlement will
be part of
$user - the user
that such account
will belong to
$assignment - an assignemt that is assigning the
object in which
context is this
expression
evaluated (e.g.
assignment of role)

</xsd:documentation>

</xsd:annotation>

</xsd:element>

tns:value

Type:	anonymous complexType, mixed content
Nillable:	(can be declared as nil using xsi:nil attribute in instance XML documents)
Defined:	locally within tns:ValueConstructionType complexType

Static value for the attribute or property. Please note that this is nillable and therefore it may be explicitly set to "nil" value. Doing this means that empty set of values should be constructed. E.g. setting this to "nil" and also setting "authoritative" flag may enforce removal of all attribute values (if used properly).

XML Source (see within schema source)

<xsd:element name="value" nillable="true">

<xsd:annotation>

<xsd:documentation>

Static value for the attribute or property.

Please note that this is nillable and therefore it
may be
explicitly set to "nil" value. Doing this
means that empty set of
values should be constructed.
E.g. setting
this to "nil"
and also
setting
"authoritative" flag may enforce removal of all
attribute
values (if used properly).

</xsd:documentation>

</xsd:annotation>

<xsd:complexType mixed="true">

<xsd:sequence>

<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="lax">

<xsd:annotation>

<xsd:documentation>

Static attribute values.
The values in this
element should be
assigned to the account as-is.

List of
values
for the attribute
provided in an propriate XML elements
that
specify attribute name.
(as is usual
for properties)

Only one
attribute may be specified
here, although it may have multiple
values. Multi-valued
attributes are
expressed by
repeating the
same XML
element multiple times.
Hence all the XML elements that
match
this xsd:any must have the same
element
names (may have
different values of course).

</xsd:documentation>

<xsd:appinfo>

<jaxb:dom/>

</xsd:appinfo>

</xsd:annotation>

</xsd:any>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

tns:valueExpression

Type:	tns:ExpressionType, complex content
Defined:	locally within tns:ValueConstructionType complexType

Expression to dynamically generate the value. See ExpressionType for more details. The expression will most likely use variables. The names and content of the variables depends on the specific usage of this type. Please refer to the containing or deriving type documentation for more details.

XML Source (see within schema source)

<xsd:element name="valueExpression" type="tns:ExpressionType">

<xsd:annotation>

<xsd:documentation>

Expression to dynamically generate the value.
See ExpressionType for more details.

The
expression will
most
likely use variables. The
names and content of the variables
depends on the
specific usage of
this type. Please refer to
the
containing or deriving type documentation for more
details.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

tns:valueFilter

Type:	tns:ValueFilterType, complex content
Defined:	by reference within tns:ValueConstructionType complexType

List of filters that will be applied to the value after it was constructed. The filters will get applied as the very last step, after the expression had run. The filters will be executed in chain in the order as specified here. The filters are supposed to "mess up" or transcode the value from XML standards to any format suitable for native storage (e.g. on resource). (but see the note in ValueFilterType documentation)

XML Source (see within schema source)

<xsd:element maxOccurs="unbounded" minOccurs="0" ref="tns:valueFilter">

<xsd:annotation>

<xsd:documentation>

List of filters that will be applied to the
value after
it was constructed. The filters will get
applied as
the
very last step, after the expression had run.

The filters will be
executed in chain in the order as
specified here.

The
filters are
supposed to "mess up" or transcode
the value from XML standards to
any format
suitable for
native storage (e.g. on
resource).
(but see
the note in ValueFilterType documentation)

</xsd:documentation>

</xsd:annotation>

</xsd:element>

tns:variable

Type:	tns:VariableDefinitionType, complex content
Defined:	locally within tns:ValueConstructionType complexType

Definition of additional variables that should be present during evaluation of the expression.

XML Source (see within schema source)

<xsd:element maxOccurs="unbounded" minOccurs="0" name="variable" type="tns:VariableDefinitionType">

<xsd:annotation>

<xsd:documentation>

Definition of additional variables that should
be
present during evaluation of the expression.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

This XML schema documentation has been generated with DocFlex/XML RE 1.8.5 using DocFlex/XML XSDDoc 2.5.0 template set.

DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high-quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.

DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-quality XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).

A commercial license for "DocFlex/XML XSDDoc" will allow you:

To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support > 400 template parameters, which work the same as "options" of ordinary doc-generators. The parameters are organized in nested groups, which form a parameter tree. Most of them have their default values calculated dynamically from a few primary parameters. So, you'll never need to specify all of them. That will give you swift and effective control over the generated content!
To use certain features disabled in the free mode (such as the full documenting of substitution groups).
To select only the initial, imported, included, redefined XML schemas to be documented or only those directly specified by name.
To include only XML schema components specified by name.
To document local element components both globally and locally (similar to attributes).
To allow/suppress unification of local elements by type.
To enable/disable reproducing of namespace prefixes.
To use PlainDoc.tpl main template to generate all the XML schema documentation in a signle-file form as both HTML and incredible quality RTF output.
To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
To remove this very advertisement text!

Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML (Full Edition) and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!

But this is not all. In addition to it, a commercial license for "DocFlex/XML SDK" will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!

Please note that by purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the results of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!

To purchase a license, please follow this link: http://www.filigris.com/shop/