com.evolveum.midpoint.xml.ns._public.common.common_1
Class ValueConstructionType

java.lang.Object
  extended by com.evolveum.midpoint.xml.ns._public.common.common_1.ValueConstructionType
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
EntitlementConstructionType, ScriptArgumentType

public class ValueConstructionType
extends java.lang.Object
implements java.io.Serializable

Defines how a value of a property (or attribute) should be constructed. The value may be static or constructed as an result of evaluating an expression. This strucuture also defines a method how to merge several value construction definitions, how to behave if a property already has a value, etc. This is reusable data structure, used in schemaHandling, roles and it may also be used in may other places. Motivation: We need to construct attribute or property values on many places in midPoint. E.g. we need that in roles to generate dynamic account attribute values, we need that to define "templates" for identifiers and default values for attributes when creating a new account. We also need that to specify values when creating a new user (user templates). Having the same data structure for all of these cases may simplify the code, as it all can be handled by a generic library reused in many places throught the system.

Java class for ValueConstructionType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ValueConstructionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://midpoint.evolveum.com/xml/ns/public/common/common-1.xsd}description" minOccurs="0"/>
         <element ref="{http://midpoint.evolveum.com/xml/ns/public/common/common-1.xsd}extension" minOccurs="0"/>
         <choice>
           <element name="value">
             <complexType>
               <complexContent>
                 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                   <sequence>
                     <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
                   </sequence>
                 </restriction>
               </complexContent>
             </complexType>
           </element>
           <sequence>
             <element name="variable" type="{http://midpoint.evolveum.com/xml/ns/public/common/common-1.xsd}VariableDefinitionType" maxOccurs="unbounded" minOccurs="0"/>
             <element name="valueExpression" type="{http://midpoint.evolveum.com/xml/ns/public/common/common-1.xsd}ExpressionType"/>
             <element name="dependency" type="{http://midpoint.evolveum.com/xml/ns/public/common/common-1.xsd}XPathType" maxOccurs="unbounded" minOccurs="0"/>
           </sequence>
         </choice>
         <element ref="{http://midpoint.evolveum.com/xml/ns/public/common/common-1.xsd}condition" minOccurs="0"/>
         <element ref="{http://midpoint.evolveum.com/xml/ns/public/common/common-1.xsd}valueFilter" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="exclusive" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="default" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="authoritative" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="clear" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:
Serialized Form

Nested Class Summary
static class ValueConstructionType.Value
          Java class for anonymous complex type.
 
Field Summary
protected  java.lang.Boolean _default
           
protected  java.lang.Boolean authoritative
           
protected  java.lang.Boolean clear
           
protected  ExpressionType condition
           
protected  java.util.List<org.w3c.dom.Element> dependency
           
protected  java.lang.String description
           
protected  java.lang.Boolean exclusive
           
protected  Extension extension
           
protected  javax.xml.bind.JAXBElement<ValueConstructionType.Value> value
           
protected  ExpressionType valueExpression
           
protected  java.util.List<ValueFilterType> valueFilter
           
protected  java.util.List<VariableDefinitionType> variable
           
 
Constructor Summary
ValueConstructionType()
           
 
Method Summary
 ExpressionType getCondition()
          The value will only be valid if the condition is evaluated to true.
 java.util.List<org.w3c.dom.Element> getDependency()
          Gets the value of the dependency property.
 java.lang.String getDescription()
          Gets the value of the description property.
 Extension getExtension()
          Gets the value of the extension property.
 javax.xml.bind.JAXBElement<ValueConstructionType.Value> getValue()
          Gets the value of the value property.
 ExpressionType getValueExpression()
          Gets the value of the valueExpression property.
 java.util.List<ValueFilterType> getValueFilter()
          List of filters that will be applied to the value after it was constructed.
 java.util.List<VariableDefinitionType> getVariable()
          Gets the value of the variable property.
 boolean isAuthoritative()
          Gets the value of the authoritative property.
 boolean isClear()
          Gets the value of the clear property.
 boolean isDefault()
          Gets the value of the default property.
 boolean isExclusive()
          Gets the value of the exclusive property.
 void setAuthoritative(java.lang.Boolean value)
          Sets the value of the authoritative property.
 void setClear(java.lang.Boolean value)
          Sets the value of the clear property.
 void setCondition(ExpressionType value)
          Sets the value of the condition property.
 void setDefault(java.lang.Boolean value)
          Sets the value of the default property.
 void setDescription(java.lang.String value)
          Sets the value of the description property.
 void setExclusive(java.lang.Boolean value)
          Sets the value of the exclusive property.
 void setExtension(Extension value)
          Sets the value of the extension property.
 void setValue(javax.xml.bind.JAXBElement<ValueConstructionType.Value> value)
          Sets the value of the value property.
 void setValueExpression(ExpressionType value)
          Sets the value of the valueExpression property.
 java.lang.String toString()
          Generates a String representation of the contents of this type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

description

protected java.lang.String description

extension

protected Extension extension

value

protected javax.xml.bind.JAXBElement<ValueConstructionType.Value> value

variable

protected java.util.List<VariableDefinitionType> variable

valueExpression

protected ExpressionType valueExpression

dependency

protected java.util.List<org.w3c.dom.Element> dependency

condition

protected ExpressionType condition

valueFilter

protected java.util.List<ValueFilterType> valueFilter

exclusive

protected java.lang.Boolean exclusive

_default

protected java.lang.Boolean _default

authoritative

protected java.lang.Boolean authoritative

clear

protected java.lang.Boolean clear
Constructor Detail

ValueConstructionType

public ValueConstructionType()
Method Detail

getDescription

public java.lang.String getDescription()
Gets the value of the description property.

Returns:
possible object is String

setDescription

public void setDescription(java.lang.String value)
Sets the value of the description property.

Parameters:
value - allowed object is String

getExtension

public Extension getExtension()
Gets the value of the extension property.

Returns:
possible object is Extension

setExtension

public void setExtension(Extension value)
Sets the value of the extension property.

Parameters:
value - allowed object is Extension

getValue

public javax.xml.bind.JAXBElement<ValueConstructionType.Value> getValue()
Gets the value of the value property.

Returns:
possible object is JAXBElement<ValueConstructionType.Value>

setValue

public void setValue(javax.xml.bind.JAXBElement<ValueConstructionType.Value> value)
Sets the value of the value property.

Parameters:
value - allowed object is JAXBElement<ValueConstructionType.Value>

getVariable

public java.util.List<VariableDefinitionType> getVariable()
Gets the value of the variable property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the variable property.

For example, to add a new item, do as follows:

    getVariable().add(newItem);
 

Objects of the following type(s) are allowed in the list VariableDefinitionType


getValueExpression

public ExpressionType getValueExpression()
Gets the value of the valueExpression property.

Returns:
possible object is ExpressionType

setValueExpression

public void setValueExpression(ExpressionType value)
Sets the value of the valueExpression property.

Parameters:
value - allowed object is ExpressionType

getDependency

public java.util.List<org.w3c.dom.Element> getDependency()
Gets the value of the dependency property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the dependency property.

For example, to add a new item, do as follows:

    getDependency().add(newItem);
 

Objects of the following type(s) are allowed in the list Element


getCondition

public ExpressionType getCondition()
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.

Returns:
possible object is ExpressionType

setCondition

public void setCondition(ExpressionType value)
Sets the value of the condition property.

Parameters:
value - allowed object is ExpressionType

getValueFilter

public java.util.List<ValueFilterType> getValueFilter()
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) Gets the value of the valueFilter property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the valueFilter property.

For example, to add a new item, do as follows:

    getValueFilter().add(newItem);
 

Objects of the following type(s) are allowed in the list ValueFilterType


isExclusive

public boolean isExclusive()
Gets the value of the exclusive property.

Returns:
possible object is Boolean

setExclusive

public void setExclusive(java.lang.Boolean value)
Sets the value of the exclusive property.

Parameters:
value - allowed object is Boolean

isDefault

public boolean isDefault()
Gets the value of the default property.

Returns:
possible object is Boolean

setDefault

public void setDefault(java.lang.Boolean value)
Sets the value of the default property.

Parameters:
value - allowed object is Boolean

isAuthoritative

public boolean isAuthoritative()
Gets the value of the authoritative property.

Returns:
possible object is Boolean

setAuthoritative

public void setAuthoritative(java.lang.Boolean value)
Sets the value of the authoritative property.

Parameters:
value - allowed object is Boolean

isClear

public boolean isClear()
Gets the value of the clear property.

Returns:
possible object is Boolean

setClear

public void setClear(java.lang.Boolean value)
Sets the value of the clear property.

Parameters:
value - allowed object is Boolean

toString

public java.lang.String toString()
Generates a String representation of the contents of this type. This is an extension method, produced by the 'ts' xjc plugin

Overrides:
toString in class java.lang.Object


Copyright © 2011 evolveum. All Rights Reserved.