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 |
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:
- Any user-defined properties that exist in the new class but not in the original class are set to the
default value defined by the new class (or to
null
if there is no default defined).
- Any user-defined properties that exist in both the original and the new class that are writable and
have the same value (including
null
) as the default value defined in the original class will be set
to the default value defined by the new class. However, any user-defined property that has had its value
modified from the default value will retain that modified value in the new class.
- Any user-defined properties whose definitions exist in the original class but not in the new class
will no longer exist on the object when its class is changed.
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:
- The document has no current lifecycle policy.
- The document is either a reservation object, or is the current version object and is not reserved.
- 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.