com.filenet.api.core
Interface ReferentialContainmentRelationship

All Superinterfaces:
ContainmentRelationship, EngineObject, IndependentlyPersistableObject, IndependentObject, Relationship, Replicable, RepositoryObject, java.io.Serializable, Subscribable
All Known Subinterfaces:
DynamicReferentialContainmentRelationship

public interface ReferentialContainmentRelationship
extends RepositoryObject, ContainmentRelationship

Represents a static relationship between two Containable subclasses: a container and a containee. The object-valued Head and Tail properties express the relationship. The tail always references a Folder (the container), while the head references the containee: another Containable subclass (such as another Folder, a CustomObject, or a Document). When the head is a Document object, it represents a specific document version.

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: ContainmentName
Searchable: true
StorageType: ObjectStore
SuperclassName: ContainmentRelationship

See Also:
Containable

Method Summary
 void changeClass(java.lang.String className)
          Changes the class of a Content Engine object.
 java.lang.String get_ContainmentName()
          Returns the value of the ContainmentName property.
 void set_ContainmentName(java.lang.String value)
          Sets the value of the ContainmentName property.
 
Methods inherited from interface com.filenet.api.core.Relationship
get_AuditedEvents, get_Creator, get_DateCreated, get_DateLastModified, get_Head, get_Id, get_LastModifier, get_Name, get_Tail, set_Creator, set_DateCreated, set_DateLastModified, set_Head, set_LastModifier, set_Tail
 
Methods inherited from interface com.filenet.api.replication.Replicable
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup
 
Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent
 
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
 
Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
 
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
 

Method Detail

get_ContainmentName

java.lang.String get_ContainmentName()
Returns the value of the ContainmentName property. For more information, see ContainmentName Property.


set_ContainmentName

void set_ContainmentName(java.lang.String value)
Sets the value of the ContainmentName property. For more information, see ContainmentName Property.


changeClass

void changeClass(java.lang.String className)
Changes the class of a Content Engine object. The new class must already exist and both it and the original class must be subclasses of the same base class. The changeClass method does not modify the security for an object, even if the object's current security is derived from the default security for its source class. For the object's user-defined properties, the following rules apply:

When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's DocumentLifecyclePolicy property if both of the following scenarios occur:

Parameters:
className - A String specifying the symbolic name, ClassNames constant, ID, or GUIDConstants constant of the class to which this object is to be changed.
Throws:
E_NULL_OR_INVALID_PARAM_VALUE - if className is null or has a length of zero.


© Copyright IBM Corporation 2006, 2008. All rights reserved.