public abstract class Control
extends java.lang.Object
Java class for Control complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="Control"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> </sequence> </restriction> </complexContent> </complexType>
The Control object is used for specifying control information in calls to VMM. It can be divided into two categories: request control and response control.
The Request control is sent from client to server within the input Root object. It is used for specifying requesting information. For example, PropertyControl is used for specifying the name of properties needing to be returned for the entity. GroupMembershipControl is used for requesting the groups the entity belongs to.
The Response control is sent from server to client within the output Root object. Response control is used for sending back control information. For example, PageResponseControl is used for sending back the cookie to the client so that the client can send back the cookie to request next page.
The Control object is at the top level of control hierarchy. All other controls are extended from it. The Control object itself is abstract and is not directly used.
Constructor and Description |
---|
Control() |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
get(java.lang.String propName)
Gets the value of the requested property
|
java.lang.String |
getDataType(java.lang.String propName)
Gets the Java type of the value of the provided property.
|
static java.util.List |
getPropertyNames(java.lang.String entityTypeName)
Gets a list of all supported properties for this model object, Control
|
static java.util.HashSet |
getSubTypes()
Gets a set of any model objects which extend this model object, Control
|
java.util.ArrayList |
getSuperTypes()
Gets a list of any model objects which this model object, Control, is
an extension of.
|
java.lang.String |
getTypeName()
Gets the name of this model object, Control
|
boolean |
isSet(java.lang.String propName)
Returns true if the requested property is set; false, otherwise.
|
boolean |
isSubType(java.lang.String superTypeName)
Returns a true if the provided model object is one that this
model object extends; false, otherwise.
|
void |
set(java.lang.String propName,
java.lang.Object value)
Sets the value of the provided property to the provided value.
|
java.lang.String |
toString()
Returns this model object, Control, and its contents as a String
|
void |
unset(java.lang.String propName)
Sets the value of provided property to null.
|
public java.lang.Object get(java.lang.String propName)
propName
- allowed object is String
Object
public boolean isSet(java.lang.String propName)
boolean
public void set(java.lang.String propName, java.lang.Object value)
propName
- allowed object is String
value
- allowed object is Object
public void unset(java.lang.String propName)
propName
- allowed object is String
public java.lang.String getTypeName()
String
public static java.util.List getPropertyNames(java.lang.String entityTypeName)
entityTypeName
- allowed object is String
List
public java.lang.String getDataType(java.lang.String propName)
propName
- allowed object is String
String
public java.util.ArrayList getSuperTypes()
ArrayList
public boolean isSubType(java.lang.String superTypeName)
superTypeName
- allowed object is String
boolean
public static java.util.HashSet getSubTypes()
HashSet
public java.lang.String toString()
toString
in class java.lang.Object
String