Packagecom.vmware.ui.relateditems.model
Classpublic class ObjectRelationSetSpec
InheritanceObjectRelationSetSpec Inheritance Object

This is a data structure that provides information about the relation specs (array of RelationSpecs) for a particular object identified by "type" and optional "conditionalProperty". The RelationSpecs can be split among several ObjectRelationSetSpec objects of same "type" and "conditionalProperty". This is vey useful for the case of extending an object with new RelationSpecs.

Specification class for vise.relateditems.specs extension point.

View the examples



Public Properties
 PropertyDefined By
  conditionalProperty : String
Optional.
ObjectRelationSetSpec
  relationSpecs : Array
Array of the RelationSpecs.
ObjectRelationSetSpec
  relationsViewId : String
Id of a view, which displays relations of an object.
ObjectRelationSetSpec
  type : String
Type of the object.
ObjectRelationSetSpec
Property Detail
conditionalPropertyproperty
public var conditionalProperty:String

Optional. A property name to additionally constraint the type of an object. This property value should be a boolean. Also, along with the property name you can specify, if needed, the negation operator "!", for example, "!isVmTemplate". This logic operator is the only one allowed.

relationSpecsproperty 
public var relationSpecs:Array

Array of the RelationSpecs.

relationsViewIdproperty 
public var relationsViewId:String

Id of a view, which displays relations of an object.

This id is optional when adding a relation to a vSphere type (like VirtualMachine) because a Related Items view is already provided by default.

typeproperty 
public var type:String

Type of the object. Usually, it is going to be type property of the ITypeReference

Examples
Here is an example of a ObjectRelationSetSpec extension in plugin.xml.
 
 <extension id="com.vmware.samples.relateditems.specs.chassis">
    <extendedPoint>vise.relateditems.specs</extendedPoint>
       <object>
       <type>Chassis</type>
       <relationsViewId>com.vmware.samples.chassis.related</relationsViewId>
       <relationSpecs>
          <com.vmware.ui.relateditems.model.RelationSpec>
           <id>rackForChassis</id>
           <icon>#{rack}</icon>
           <label>#{rackLabel}</label>
           <relation>rack</relation>
           <targetType>Rack</targetType>
           <listViewId>com.vmware.samples.rackList</listViewId>
           </com.vmware.ui.relateditems.model.RelationSpec>
        </relationSpecs>
     </object>
  </extension>