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

java.lang.Object
  extended by com.evolveum.midpoint.xml.ns._public.common.common_1.AttributeDescriptionType
All Implemented Interfaces:
java.io.Serializable

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

Description of the attribute handling, such as display name, read/write access and value and synchronization expressions. This is supposed to be used in schemaHandling part and therefore describe the decisions of the system administrator about the way how that attribute is used in midPoint. This is supposed to be used only in schemaHandling. It is not a reusable data structure (composition).

Java class for AttributeDescriptionType complex type.

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

 <complexType name="AttributeDescriptionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://midpoint.evolveum.com/xml/ns/public/common/common-1.xsd}name" minOccurs="0"/>
         <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}ignore" minOccurs="0"/>
         <element ref="{http://midpoint.evolveum.com/xml/ns/public/common/common-1.xsd}access" maxOccurs="unbounded" minOccurs="0"/>
         <element name="outbound" type="{http://midpoint.evolveum.com/xml/ns/public/common/common-1.xsd}ValueConstructionType" minOccurs="0"/>
         <element name="inbound" type="{http://midpoint.evolveum.com/xml/ns/public/common/common-1.xsd}ValueAssignmentType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="ref" type="{http://www.w3.org/2001/XMLSchema}QName" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:
Serialized Form

Field Summary
protected  java.util.List<AccessType> access
           
protected  java.lang.String description
           
protected  java.lang.Boolean ignore
           
protected  java.util.List<org.w3c.dom.Element> inbound
           
protected  java.lang.String name
           
protected  ValueConstructionType outbound
           
protected  javax.xml.namespace.QName ref
           
 
Constructor Summary
AttributeDescriptionType()
           
 
Method Summary
 java.util.List<AccessType> getAccess()
          Access to the attribute as defined by the system administrator or deployer.
 java.lang.String getDescription()
          Gets the value of the description property.
 java.util.List<org.w3c.dom.Element> getInbound()
          Gets the value of the inbound property.
 java.lang.String getName()
          Human readable name for the account attribute.
 ValueConstructionType getOutbound()
          Gets the value of the outbound property.
 javax.xml.namespace.QName getRef()
          Gets the value of the ref property.
 java.lang.Boolean isIgnore()
          Gets the value of the ignore property.
 void setDescription(java.lang.String value)
          Sets the value of the description property.
 void setIgnore(java.lang.Boolean value)
          Sets the value of the ignore property.
 void setName(java.lang.String value)
          Sets the value of the name property.
 void setOutbound(ValueConstructionType value)
          Sets the value of the outbound property.
 void setRef(javax.xml.namespace.QName value)
          Sets the value of the ref 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

name

protected java.lang.String name

description

protected java.lang.String description

ignore

protected java.lang.Boolean ignore

access

protected java.util.List<AccessType> access

outbound

protected ValueConstructionType outbound

inbound

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

ref

protected javax.xml.namespace.QName ref
Constructor Detail

AttributeDescriptionType

public AttributeDescriptionType()
Method Detail

getName

public java.lang.String getName()
Human readable name for the account attribute. This name may be displayd in tools and GUIs to provide more pleasant user experience, as the native attribute names may look quite frightening (especially in LDAP).

Returns:
possible object is String

setName

public void setName(java.lang.String value)
Sets the value of the name property.

Parameters:
value - allowed object is String

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

isIgnore

public java.lang.Boolean isIgnore()
Gets the value of the ignore property.

Returns:
possible object is Boolean

setIgnore

public void setIgnore(java.lang.Boolean value)
Sets the value of the ignore property.

Parameters:
value - allowed object is Boolean

getAccess

public java.util.List<AccessType> getAccess()
Access to the attribute as defined by the system administrator or deployer. This can constrain the access defined by resource schema annotations. Specifying broader access that the resource connector can handle is an error. If no access is specified, it defaults to read-write. Gets the value of the access 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 access property.

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

    getAccess().add(newItem);
 

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


getOutbound

public ValueConstructionType getOutbound()
Gets the value of the outbound property.

Returns:
possible object is ValueConstructionType

setOutbound

public void setOutbound(ValueConstructionType value)
Sets the value of the outbound property.

Parameters:
value - allowed object is ValueConstructionType

getInbound

public java.util.List<org.w3c.dom.Element> getInbound()
Gets the value of the inbound 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 inbound property.

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

    getInbound().add(newItem);
 

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


getRef

public javax.xml.namespace.QName getRef()
Gets the value of the ref property.

Returns:
possible object is QName

setRef

public void setRef(javax.xml.namespace.QName value)
Sets the value of the ref property.

Parameters:
value - allowed object is QName

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.