com.filenet.api.constants
Class MergeMode

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

public class MergeMode
extends java.lang.Object
implements java.io.Serializable

Determines how the search results are merged for searches across multiple repositories. The merge mode can be either:

When the merge mode is UNION and a class or property is not found in any repository, the following occurs:

See Also:
SearchScope, JoinOperator, Merge Mode in the Help for Content Engine Development, Serialized Form

Field Summary
static MergeMode INTERSECTION
          A constant representing a MergeMode instance of type INTERSECTION.
static int INTERSECTION_AS_INT
          An integer associated with the INTERSECTION instance of this class.
static MergeMode UNION
          A constant representing a MergeMode instance of type UNION.
static int UNION_AS_INT
          An integer associated with the UNION instance of this class.
 
Method Summary
static MergeMode getInstanceFromInt(int value)
          Gets the instance of this class using its associated integer value (the *_AS_INT fields).
 int getValue()
          Returns an integer value associated with a specific instance of this class.
 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

INTERSECTION_AS_INT

public static final int INTERSECTION_AS_INT
An integer associated with the INTERSECTION instance of this class.

Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.

See Also:
Constant Field Values

INTERSECTION

public static final MergeMode INTERSECTION
A constant representing a MergeMode instance of type INTERSECTION. This specifies that the search result is the intersection of the classes found across the repositories (the classes occurring in every repository searched).

See Also:
getValue(), getInstanceFromInt(int)

UNION_AS_INT

public static final int UNION_AS_INT
An integer associated with the UNION instance of this class.

Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.

See Also:
Constant Field Values

UNION

public static final MergeMode UNION
A constant representing a MergeMode instance of type UNION. This specifies that the search result is the union of the classes found across the repositories (the classes occurring in any repository searched).

See Also:
getValue(), getInstanceFromInt(int)
Method Detail

getValue

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

Returns:
An integer representing a specific instance of this class.

getInstanceFromInt

public static MergeMode getInstanceFromInt(int value)
Gets the instance of this class using its associated integer value (the *_AS_INT fields).

Parameters:
value - An integer representing a particular static instance of this class.
Returns:
The MergeMode instance referenced.
Throws:
EngineRuntimeException - Thrown when the parameter is null or invalid.

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.


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