com.filenet.api.constants
Class ComponentRelationshipType

java.lang.Object
  extended by com.filenet.api.constants.ComponentRelationshipType
All Implemented Interfaces:
java.io.Serializable

public final class ComponentRelationshipType
extends java.lang.Object
implements java.io.Serializable

Defines settings that determine the type of compound document relationship between a child document and a parent document. For additional information on component relationship types, including the required properties you must set to create a new ComponentRelationship object of each type, see ComponentRelationshipType Property.

See Also:
Serialized Form

Field Summary
static ComponentRelationshipType DYNAMIC_CR
          Binds the parent component version to the most recent child component version that satisfies the version bind rule.
static int DYNAMIC_CR_AS_INT
          An int value associated with the DYNAMIC_CR instance of this class.
static ComponentRelationshipType DYNAMIC_LABEL_CR
          Binds the parent component version to the most recent child component version satisfying the version bind rule that has a ComponentBindingLabel property value matching the LabelBindValue property value.
static int DYNAMIC_LABEL_CR_AS_INT
          An int value associated with the DYNAMIC_LABEL_CR instance of this class.
static ComponentRelationshipType STATIC_CR
          Binds the parent component version to the explicitly specified child component version.
static int STATIC_CR_AS_INT
          An int value associated with the STATIC_CR instance of this class.
static ComponentRelationshipType URICR
          Creates a component relationship between the parent component document and the URI document specified by the URIValue property.
static int URICR_AS_INT
          An int value associated with the URICR instance of this class.
 
Method Summary
static ComponentRelationshipType getInstanceFromInt(int value)
          Returns an instance of this class using its associated integer value.
 int getValue()
          Returns the internal integer value associated with a specific instance of this class.
 java.lang.String toString()
          Returns a String representation of this enumeration instance.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DYNAMIC_CR_AS_INT

public static final int DYNAMIC_CR_AS_INT
An int value associated with the DYNAMIC_CR instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

DYNAMIC_CR

public static final ComponentRelationshipType DYNAMIC_CR
Binds the parent component version to the most recent child component version that satisfies the version bind rule.


DYNAMIC_LABEL_CR_AS_INT

public static final int DYNAMIC_LABEL_CR_AS_INT
An int value associated with the DYNAMIC_LABEL_CR instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

DYNAMIC_LABEL_CR

public static final ComponentRelationshipType DYNAMIC_LABEL_CR
Binds the parent component version to the most recent child component version satisfying the version bind rule that has a ComponentBindingLabel property value matching the LabelBindValue property value. No binding occurs if no such child document version exists.


URICR_AS_INT

public static final int URICR_AS_INT
An int value associated with the URICR instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

URICR

public static final ComponentRelationshipType URICR
Creates a component relationship between the parent component document and the URI document specified by the URIValue property.


STATIC_CR_AS_INT

public static final int STATIC_CR_AS_INT
An int value associated with the STATIC_CR instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

STATIC_CR

public static final ComponentRelationshipType STATIC_CR
Binds the parent component version to the explicitly specified child component version.

Method Detail

getValue

public int getValue()
Returns the internal integer value associated with a specific instance of this class.

Returns:
The enumeration instance's ordinal value.
See Also:
getInstanceFromInt(int)

toString

public java.lang.String toString()
Returns a String representation of this enumeration instance.

Overrides:
toString in class java.lang.Object
Returns:
The enumeration instance's description.

getInstanceFromInt

public static ComponentRelationshipType getInstanceFromInt(int value)
Returns an instance of this class using its associated integer value.

Parameters:
value - The integer value. (See the *_AS_INT fields.)
Returns:
The enumeration instance with the given ordinal value.
Throws:
EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
See Also:
getValue()


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