ObjectReference Element

System.Object
  ObjectEntryType
    WithObjectIdentityType
      ObjectReference
        ObjectSpecification
Client Declaration
  public class ObjectReference
Represents information that identifies an independent Content Engine object. An independent object is instantiated from a subclass of the IndependentObject class. It is addressable and has a unique identity by which it can be referenced for retrieval or update.

Base Element Inheritance

Attributes
  • String classId:
    • [request] Required expression identifying the class of the object. This attribute can specify either a symbolic name or a GUID.
    • [response] Required expression specifying the symbolic name of the class of the object.
  • String objectId:
    • [request] Required (except for EntireNetwork objects and query result rows) expression specifying the GUID of an object. Exceptions apply for the following object types:
      • Realm: The name of the realm must be specified.
      • Group or User: The principal name of the group or user must be specified.
      • ClassDescription: The symbolic name of an object's class can be specified instead of an object's GUID.
    • [response] Required (except for EntireNetwork objects and query result rows) expression specifying the GUID of an object. Exceptions apply for the following object types:
      • Realm: The name of the realm must be specified.
      • Group or User: The principal name of the group or user must be specified.
  • String objectStore:
    • [request] Required (optional for objects that are not stored in the database repository) expression identifying the object store to which a specified object belongs. This attribute can specify a symbolic name, display name, or GUID.
    • [response] Required (omitted for objects that are not stored in the database repository) expression specifying the GUID of the object store to which a specified object belongs.
  • Boolean serializationDuplicate: [response] Optional expression specifying whether this ObjectReference element has resulted from duplicate object suppression (true) or not (false). (Duplicate object suppression causes an ObjectReference element to be returned in a response instead of an ObjectValue element.) For more information about duplicate object suppression, see Duplicate Object Suppression.
Attributes Specific to .NET Clients
  • Boolean serializationDuplicateSpecified: Optional expression specifying whether serializationDuplicate has a value (true) or not (false).

Code Example

// Create an object reference to the root folder
ObjectReference objRootFolder = new ObjectReference();

//Specify its class, object ID, and object store
objRootFolder.classId = "Folder";
objRootFolder.objectId = "{0F1E2D3C-4B5A-6978-8796-A5B4C3D2E1F0}";
objRootFolder.objectStore = "MyObjectStore";

XML Schema

<xsd:complexType name="ObjectReference">
   <xsd:complexContent>
      <xsd:extension base="WithObjectIdentityType"/>
   </xsd:complexContent>
</xsd:complexType>