com.filenet.rm.bds

Interface ObjectReference

All Superinterfaces:
java.lang.Cloneable
All known subinterfaces:
ContainerReference, DocumentReference

  1. public interface ObjectReference
  2. 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

Modifier and Type Method and Description
  1. java.lang.Object
clone()
Defined in order to support the extended Clonable interface.
  1. 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.
  1. java.lang.String
getObjectIdent()
Returns the identifier (either Name, Id or Path) of the CE object to which this ObjectReference instance refers to.
  1. java.lang.String
getObjectStoreIdent()
Returns the identifier (either Name or ID property) of the ObjectStore onto which the referred object resides.

Method Detail

getObjectStoreIdent

  1. 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

  1. 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

  1. 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

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