com.filenet.rm.bds

Interface ObjectReference

  • All Superinterfaces:
    java.lang.Cloneable
    All Known Subinterfaces:
    ContainerReference, DocumentReference


    public interface ObjectReference
    extends java.lang.Cloneable
    The ObjectReference interface represents an existing CE object. It is used to refer to existing document and/or folder objects and act as the value for PropertyValue instances of type DataType.TYPE_OBJECT.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Object clone()
      Defined in order to support the extended Clonable interface.
      java.lang.String getClassIdent()
      Returns the identifier (either Name or ID property) of the class definition on which the object defined by this definition instance is to be based upon.
      java.lang.String getObjectIdent()
      Returns the identifier (either Name, Id or Path) of the CE object to which this ObjectReference instance refers to.
      java.lang.String getObjectStoreIdent()
      Returns the identifier (either Name or ID property) of the ObjectStore onto which the referred object resides.
    • Method Detail

      • getObjectStoreIdent

        java.lang.String getObjectStoreIdent()
        Returns the identifier (either Name or ID property) of the ObjectStore onto which the referred object resides.
        Returns:
        Name or Id property of the associated ObjectStore.
      • getClassIdent

        java.lang.String getClassIdent()
        Returns the identifier (either Name or ID property) of the class definition on which the object defined by this definition instance is to be based upon.
        Returns:
        Name or Id property of the associated class definition.
      • getObjectIdent

        java.lang.String getObjectIdent()
        Returns the identifier (either Name, Id or Path) of the CE object to which this ObjectReference instance refers to.
        Returns:
        String identifier for the CE object in question. For a ClassDescription, this can be its Id or Name. For other objects can be its Path or Id.
      • clone

        java.lang.Object clone()
        Defined in order to support the extended Clonable interface.
        Returns:
        a new instance that is a clone of this instance.

© Copyright IBM Corp. 2006, 2013. All Rights Reserved.