Content Engine Java API: AutoUniqueName

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.filenet.api.constants.AutoUniqueName

All Implemented Interfaces:

java.io.Serializable
```
public class AutoUniqueName
extends java.lang.Object
implements java.io.Serializable
```
Specifies whether naming collisions are to be detected and automatically resolved for containment names. Containment names are set on ReferentialContainmentRelationship or DynamicReferentialContainmentRelationship objects.
If auto-unique naming is enabled, and a naming collision is detected, the containment name of the object is automatically appended with a suffix to make the name unique. For details, see the ContainmentName property.

CAUTION: Enabling auto-unique naming can have a severe performance impact when used for large numbers of objects filed in the same folder using a duplicate containment name. Under certain conditions, the Content Engine might retry the filing operation many times before the filing operation succeeds. In those cases, timeouts can occur. Therefore, your client application should ensure that unique containment names are created for each object, so that the auto-unique naming is only needed infrequently.

See Also:
ReferentialContainmentRelationship, DynamicReferentialContainmentRelationship, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static AutoUniqueName`	`AUTO_UNIQUE` A constant representing an instance of type `AUTO_UNIQUE`.
`static AutoUniqueName`	`NOT_AUTO_UNIQUE` A constant representing an instance of type `NOT_AUTO_UNIQUE`.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`getBooleanValue()` Returns the `Boolean` value associated with this instance.
`static AutoUniqueName`	`getInstanceFromBoolean(boolean val)` Creates an instance of this class having the specified auto-unique setting.
`boolean`	`getValue()` Returns the `boolean` value associated with this instance.
`java.lang.String`	`toString()` Returns a `String` representation of this instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - AUTO_UNIQUE
```
public static final AutoUniqueName AUTO_UNIQUE
```
    A constant representing an instance of type AUTO_UNIQUE. This specifies that containment naming collisions are to be detected and resolved.
  - NOT_AUTO_UNIQUE
```
public static final AutoUniqueName NOT_AUTO_UNIQUE
```
    A constant representing an instance of type NOT_AUTO_UNIQUE. This specifies that containment naming collisions are not to be detected and resolved.
- Method Detail
  - getValue
```
public boolean getValue()
```
    Returns the boolean value associated with this instance.
    
    Returns:
    A boolean value of true or false.
  - getBooleanValue
```
public java.lang.Boolean getBooleanValue()
```
    Returns the Boolean value associated with this instance.
    
    Returns:
    A Boolean value of true or false.
  - getInstanceFromBoolean
```
public static AutoUniqueName getInstanceFromBoolean(boolean val)
```
    Creates an instance of this class having the specified auto-unique setting.
    
    Parameters:
    val - A boolean value of true to indicate auto-unique naming is enabled; false otherwise.
    
    Returns:
    An AutoUniqueName object having the specified setting.
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    A String representing the instance.