Content Engine Java API: JoinOperator

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

All Implemented Interfaces:

java.io.Serializable
```
public final class JoinOperator
extends java.lang.Object
implements java.io.Serializable
```
Specifies the type of join to use when querying multiple class instances (tables). This class is used when constructing SQL statements with the SearchSQL class. The join type and behavior is that of the corresponding ANSI/ISO SQL99-compliant joins.

See Also:
SearchSQL.setFromClauseAdditionalJoin, JoinComparison, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static JoinOperator`	`FULL_OUTER` Indicates a full outer join.
`static int`	`FULL_OUTER_AS_INT` An `int` value associated with the FULL_OUTER instance of this class.
`static JoinOperator`	`INNER` Indicates an inner join.
`static int`	`INNER_AS_INT` An `int` value associated with the INNER instance of this class.
`static JoinOperator`	`LEFT_OUTER` Indicates a left outer join.
`static int`	`LEFT_OUTER_AS_INT` An `int` value associated with the LEFT_OUTER instance of this class.
`static JoinOperator`	`RIGHT_OUTER` Indicates a right outer join.
`static int`	`RIGHT_OUTER_AS_INT` An `int` value associated with the RIGHT_OUTER instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static JoinOperator`	`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
  - FULL_OUTER_AS_INT
```
public static final int FULL_OUTER_AS_INT
```
    An int value associated with the FULL_OUTER 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
  - FULL_OUTER
```
public static final JoinOperator FULL_OUTER
```
    Indicates a full outer join.
  - INNER_AS_INT
```
public static final int INNER_AS_INT
```
    An int value associated with the INNER 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
  - INNER
```
public static final JoinOperator INNER
```
    Indicates an inner join.
  - LEFT_OUTER_AS_INT
```
public static final int LEFT_OUTER_AS_INT
```
    An int value associated with the LEFT_OUTER 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
  - LEFT_OUTER
```
public static final JoinOperator LEFT_OUTER
```
    Indicates a left outer join.
  - RIGHT_OUTER_AS_INT
```
public static final int RIGHT_OUTER_AS_INT
```
    An int value associated with the RIGHT_OUTER 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
  - RIGHT_OUTER
```
public static final JoinOperator RIGHT_OUTER
```
    Indicates a right outer join.
- 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 JoinOperator 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()

Methods inherited from class java.lang.Object

FULL_OUTER_AS_INT

FULL_OUTER

INNER_AS_INT

INNER

LEFT_OUTER_AS_INT

LEFT_OUTER

RIGHT_OUTER_AS_INT

RIGHT_OUTER

getValue

toString

getInstanceFromInt