PropertyControl DataObject

PropertyControl is used to specify which properties of an entity are returned.

PropertyControl is used in the input data object of the get API to specify the properties of the entity to return.

The structure of a PropertyControl data object consists of:
properties
is used for adding the names of the properties. If the property contains a wildcard value "*", all the supported properties of the entity are returned.
contextProperties
is used for adding names of the context properties and the metadata, for example, a property with the metadata 'lang'. There are no built-in contextProperties defined.

XML schema definition

The following is the XML schema definition for the PropertyControl DataObject:
<xsd:complexType name="PropertyControl">
    <xsd:complexContent>
        <xsd:extension base="Control">
	     <xsd:sequence>
	         <xsd:element name="properties" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
		  <xsd:element name="contextProperties" minOccurs="0" maxOccurs="unbounded">
		      <xsd:complexType>
		          <xsd:simpleContent>
			      <xsd:extension base="xsd:string">
				  <xsd:attribute ref="xml:lang" />
			      </xsd:extension>
			   </xsd:simpleContent>
		       </xsd:complexType>
		   </xsd:element>		
	      </xsd:sequence>
	  </xsd:extension>
     </xsd:complexContent>
</xsd:complexType>

Sample data object

The following is a sample PropertyControl DataObject which is used in the get operation for requesting uid, cn, sn properties:
<wim:controls xsi:type="wim:PropertyControl">
      <wim:properties>cn</wim:properties>
      <wim:properties>uid</wim:properties>
      <wim:properties>sn</wim:properties>
</wim:controls>
Terms of use | Feedback
(C) Copyright IBM Corporation 2005. All Rights Reserved.
IBM virtual member manager 6.1