SingletonObject Element

System.Object
  PropertyType
    ModifiablePropertyType
      SingletonObject

Client Declaration

  public class SingletonObject

Represents a Content Engine property that holds a single Content Engine object value.

Element Structure

Elements

ObjectEntryType Value: Optional element specifying the object value held by the property.
- [request] The object can be represented by one of the following elements, according to its format:
  - Object by reference: ObjectReference or ObjectSpecification
  - Unevaluated object (empty): Unevaluated
- [response] The object can be represented by one of the following elements, according to its format. Normally, object representation is by reference; object representation is by value when the property has been expanded through recursion:
  - Object by reference: ObjectReference
  - Object by value: ObjectValue
  - Unevaluated object (empty): Unevaluated
  - Error when attempting an object by value expansion: RetrievalError

Base Element Inheritance

Attributes

String propertyId:
- [request] Required expression identifying the Content Engine property. This attribute can specify either a symbolic name or a GUID.
- [response] Required expression specifying the symbolic name of the Content Engine property.
Boolean settable: [response] Optional expression specifying whether the specified Content Engine property is settable by the user (true) or not (false). If true, this attribute's value is "1"; otherwise, this attribute is omitted in the response.

Attributes Specific to .NET Clients

Boolean settableSpecified: Optional expression specifying whether settable has a value (true) or not (false).

Code Example

// Specify and set an object-valued property for the Parent property
SingletonObject propParent = new SingletonObject();
propParent.propertyId = "Parent";


// Set its value to an object reference
propParent.Value = (ObjectEntryType)objRef;

XML Schema

<xsd:complexType name="SingletonObject">
   <xsd:complexContent>
      <xsd:extension base="ModifiablePropertyType">
         <xsd:sequence>
            <xsd:element name="Value" type="ObjectEntryType" minOccurs="0"/>
         </xsd:sequence>
      </xsd:extension>
   </xsd:complexContent>
</xsd:complexType>