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


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

Syntax

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

Parameters

joinOperator
A JoinOperator instance specifying the type of join to use for the additional class.
symbolicClassName
A String containing the symbolic name of the class.
aliasName
A String containing the alias name of the class. This can be Null.
Note
Alias names cannot be used when EngineObject objects are to be returned by the query operation.
joinVar1
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
A JoinComparison instance specifying the comparison to use for the constituents of the ON clause (joinVar1 and joinVar2).
joinVar2
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
A Boolean value of True if the FROM clause should include any subclasses of the class specified in symbolicClassName; False otherwise.

Exceptions

Exception TypeCondition
EngineRuntimeException Thrown when the parameter is Null or invalid.

See Also