Adds another class to the FROM clause used in the SQL statement.

Namespace:  FileNet.Api.Query
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Public Overridable Sub SetFromClauseAdditionalJoin ( _
	joinOperator As JoinOperator, _
	symbolicClassName As String, _
	aliasName As String, _
	joinVar1 As String, _
	joinComparison As JoinComparison, _
	joinVar2 As String, _
	includeSubclasses As Boolean _
)
C#
public virtual void SetFromClauseAdditionalJoin(
	JoinOperator joinOperator,
	string symbolicClassName,
	string aliasName,
	string joinVar1,
	JoinComparison joinComparison,
	string joinVar2,
	bool includeSubclasses
)
Visual C++
public:
virtual void SetFromClauseAdditionalJoin(
	JoinOperator joinOperator, 
	String^ symbolicClassName, 
	String^ aliasName, 
	String^ joinVar1, 
	JoinComparison^ joinComparison, 
	String^ joinVar2, 
	bool includeSubclasses
)
JavaScript
function setFromClauseAdditionalJoin(joinOperator, symbolicClassName, aliasName, joinVar1, joinComparison, joinVar2, includeSubclasses);

Parameters

joinOperator
Type: FileNet.Api.Constants..::.JoinOperator
A JoinOperator instance specifying the type of join to use for the additional class.
symbolicClassName
Type: System..::.String
A String containing the symbolic name of the class.
aliasName
Type: System..::.String
A String containing the alias name of the class. This can be Null.
Note Note: Alias names cannot be used when EngineObject objects are to be returned by the query operation.
joinVar1
Type: System..::.String
A String containing the name of a property on the initial class specified in SetFromClauseInitialValue. In tandem with the property specified in joinVar2, this property specifies the ON clause constituents of the join.
joinComparison
Type: FileNet.Api.Constants..::.JoinComparison
A JoinComparison instance specifying the comparison to use for the constituents of the ON clause (joinVar1 and joinVar2).
joinVar2
Type: System..::.String
A String containing the name of a property on the class specified in symbolicClassName. In tandem with the property specified in joinVar1, this property specifies the ON clause constituents of the join.
includeSubclasses
Type: System..::.Boolean
A Boolean value of True if the FROM clause should include any subclasses of the class specified in symbolicClassName; False otherwise.

ToggleExceptions

ExceptionCondition
FileNet.Api.Exception..::.EngineRuntimeException Thrown when the parameter is Null or invalid.

ToggleSee Also