Class PropertyControl
- Direct Known Subclasses:
SearchControl
Java class for PropertyControl complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="PropertyControl">
<complexContent>
<extension base="{http://www.ibm.com/websphere/wim}Control">
<sequence>
<element name="properties" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
<element name="contextProperties" maxOccurs="unbounded" minOccurs="0">
<complexType>
<simpleContent>
<extension base="<http://www.w3.org/2001/XMLSchema>string">
<attribute ref="{http://www.w3.org/XML/1998/namespace}lang"/>
</extension>
</simpleContent>
</complexType>
</element>
</sequence>
</extension>
</complexContent>
</complexType>
The PropertyControl object extends the Control object.
PropertyControl is used in the input Root object of the get() API to specify the properties of the entity to be returned.
- properties: a list of the properties to return from the entities which match the search criteria. For example, properties may include the 'sn' and 'givenName' attributes of the users who are managers.
- contextProperties: used for adding names of the contexted properties and the meta data, for e.g. the description property with meta data 'lang=FR'.
If the property 'properties' contains a wildcard value '*', all supported properties of the entity will be returned
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classJava class for anonymous complex type. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the value of the requested propertyGets the value of the contextProperties property.getDataType(String propName) Gets the Java type of the value of the provided property.Gets the value of the properties property.static ListgetPropertyNames(String entityTypeName) static HashSetGets a list of any model objects which this model object, Control, is an extension of.Gets the name of this model object, ControlbooleanReturns true if the requested property is set; false, otherwise.booleanbooleanbooleanReturns a true if the provided model object is one that this model object extends; false, otherwise.voidSets the value of the provided property to the provided value.toString()Returns this model object, Control, and its contents as a StringvoidSets the value of provided property to null.voidvoid
-
Constructor Details
-
PropertyControl
public PropertyControl()
-
-
Method Details
-
getProperties
Gets the value of the properties 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
setmethod for the properties property.For example, to add a new item, do as follows:
getProperties().add(newItem);
Objects of the following type(s) are allowed in the list
String -
isSetProperties
public boolean isSetProperties() -
unsetProperties
public void unsetProperties() -
getContextProperties
Gets the value of the contextProperties 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
setmethod for the contextProperties property.For example, to add a new item, do as follows:
getContextProperties().add(newItem);
Objects of the following type(s) are allowed in the list
PropertyControl.ContextProperties -
isSetContextProperties
public boolean isSetContextProperties() -
unsetContextProperties
public void unsetContextProperties() -
get
Description copied from class:ControlGets the value of the requested property -
isSet
Description copied from class:ControlReturns true if the requested property is set; false, otherwise. -
set
Description copied from class:ControlSets the value of the provided property to the provided value. -
unset
Description copied from class:ControlSets the value of provided property to null. -
getTypeName
Description copied from class:ControlGets the name of this model object, Control- Overrides:
getTypeNamein classControl- Returns:
- returned object is
String
-
getPropertyNames
-
getDataType
Description copied from class:ControlGets the Java type of the value of the provided property. For example: String, List- Overrides:
getDataTypein classControl- Parameters:
propName- allowed object isString- Returns:
- returned object is
String
-
getSuperTypes
Description copied from class:ControlGets a list of any model objects which this model object, Control, is an extension of.- Overrides:
getSuperTypesin classControl- Returns:
- returned object is
ArrayList
-
isSubType
Description copied from class:ControlReturns a true if the provided model object is one that this model object extends; false, otherwise. -
getSubTypes
-
toString
Description copied from class:ControlReturns this model object, Control, and its contents as a String
-