com.vmware.vise.data.query

Class RelationalConstraint

java.lang.Object

com.vmware.vise.data.Constraint

com.vmware.vise.data.query.RelationalConstraint

All Implemented Interfaces:

java.lang.Cloneable

public class RelationalConstraint
extends Constraint

Defines the matching criteria based on some relation to the object queried.

Eg. VirtualMachines whose host is esx1.vmware.com

Field Summary

Fields

Modifier and Type	Field and Description
Constraint	constraintOnRelatedObject A constraint on the related objects by the given relationship.
boolean	hasInverseRelation Indicates whether the constraint given by constraintOnRelatedObject applies to the source, as opposed to the target of the relationship given in this instance.
java.lang.String	relation The relation to match (the source type of the relation is defined by the isSourceConstrainted property).

Fields inherited from class com.vmware.vise.data.Constraint

targetType

Constructor Summary

Constructors

Constructor and Description
RelationalConstraint()

Method Summary

Modifier and Type	Method and Description
RelationalConstraint	clone() Creates and returns a copy of this object.
boolean	equals(java.lang.Object obj)
int	hashCode()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

relation

public java.lang.String relation

The relation to match (the source type of the relation is defined by the isSourceConstrainted property).

VMODL1 property names must never be qualified with resource model name (i.e. for resource type "VirtualMachine", property "name" is valid while "VirtualMachine/name" is not). VMODL2 property names must always be qualified with resource model name.

hasInverseRelation

public boolean hasInverseRelation

Indicates whether the constraint given by constraintOnRelatedObject applies to the source, as opposed to the target of the relationship given in this instance. It is useful when the client only knows one-way relationship between objects.

If true, the relation defined by constraintOnRelatedObject.targetType.relationship is used. Thus the constraint can be referred to as an inverse-RelationalConstraint (as the inverse relationship is used compared to the normal direction). Make sure to explicitly set the constraintOnRelatedObject.targetType value.

Example:

            RelationalConstraint {
               targetType = "VirtualMachine",
               relationship = "vm",   // HostSystem.vm relationship is used
               hasInverseRelation = true,
               constraintOnRelatedObject =
                  ObjectIdentityConstraint {
                     targetType = "HostSystem"
                     target = "host-1"
                  }
            }
 

If false (i.e. the target is constrained), the relation defined by this.targetType.relationship is used.

Example:

            RelationalConstraint {
               targetType = "VirtualMachine",
               relationship = "host",   // VirtualMachine.Host relationship is used
               hasInverseRelation = false,
               constraintOnRelatedObject =
                  ObjectIdentityConstraint {
                     targetType = null, // implicitly "HostSystem"
                     target = "host-1"
                  }
            }
 

Default value is false.

constraintOnRelatedObject

public Constraint constraintOnRelatedObject

A constraint on the related objects by the given relationship. This further filtering can be based on either the identity of the related objects or their properties or some further nested relationship.

Constructor Detail

RelationalConstraint

public RelationalConstraint()

Method Detail

clone

public RelationalConstraint clone()
                           throws java.lang.CloneNotSupportedException

Creates and returns a copy of this object.

Overrides:

clone in class Constraint

Returns:

a copy of this object.

Throws:

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Constraint

hashCode

public int hashCode()

Overrides:

hashCode in class Constraint