com.filenet.rm.bds
Interface ContainerReference
All Superinterfaces:
java.lang.Cloneable, ObjectReference
- public interface ContainerReference
- extends ObjectReference
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getAutoUniqueNaming()
Reflects the current state of the auto-unique containment naming option for this
ContainerReference .
|
|
getContainmentName()
Reflects the current state of the containment name value, if any, assigned
to this
ContainerReference instance.
|
|
setAutoUniqueNaming(boolean value)
Controls whether naming collisions are to be automatically resolved for
containment names.
|
|
setContainmentName(java.lang.String containmentName)
Defines an optional string to be used as the containment name of the record
or document object to be filed in the container defined by this
ContainerReference .
|
Methods inherited from interface com.filenet.rm.bds.ObjectReference |
---|
clone, getClassIdent, getObjectIdent, getObjectStoreIdent |
Method Detail
setAutoUniqueNaming
- void setAutoUniqueNaming(boolean value)
Parameters:
value
- true
to enable auto-unique containment naming (default value). getAutoUniqueNaming
- boolean getAutoUniqueNaming()
Reflects the current state of the auto-unique containment naming option for this
ContainerReference
.
Returns:
true
if auto-unique naming is enabled. setContainmentName
- void setContainmentName(java.lang.String containmentName)
Defines an optional string to be used as the containment name of the record
or document object to be filed in the container defined by this
ContainerReference
.
If no containment name has been specified, the CE defaults to the value of the special
"Name" property belonging to the contained object (e.g. "DocumentTitle").
The following characters are not allowed:
\ / : * ? " < > |
For backwards compatibility with previous versions of the BDS, the ContainmentName
defaults to null
.
Parameters:
containmentName
- String containing the containment name to assign to the
filed object. Can be null
. getContainmentName
- java.lang.String getContainmentName( )
Reflects the current state of the containment name value, if any, assigned
to this
ContainerReference
instance.
Returns:
current value of the containment name.
Can be
null
.
For backwards compatibility with previous versions of the BDS, AutoUniqueNaming defaults to enabled (
true
).Note that this auto-naming process does have a detrimental effect upon record declaration and/or document creation performance. For best performance, AutoUniqueNaming should be disabled if, and only if, the BDS client can supply a unique ContainmentName and/or DocumentTitle property value.