com.crystaldecisions.sdk.occa.report.data
Class TableJoinEnforced

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.TableJoinEnforced

public final class TableJoinEnforced
extends java.lang.Object

Defines the manner in which two tables are joined.

See Also:
ITableJoin.setEnforceJoin(TableJoinEnforced)

Field Summary
static int _both
          Enforced both.
static int _from
          Enforced from.
static int _notEnforced
          Not enforced.
static int _to
          Enforced to.
static TableJoinEnforced both
          A TableJoinEnforced object that specifies option "Enforced Both".
static TableJoinEnforced from
          A TableJoinEnforced object that specifies option "Enforced From".
static TableJoinEnforced notEnforced
          A TableJoinEnforced object that specifies option "Not Enforced".
static TableJoinEnforced to
          A TableJoinEnforced object that specifies option "Enforced To".
 
Method Summary
static TableJoinEnforced from_int(int i)
          Returns the TableJoinEnforced object corresponding to the specified int.
static TableJoinEnforced from_string(java.lang.String type)
          Returns the TableJoinEnforced object corresponding to the specified String.
 java.lang.String toString()
          Returns the String value of this TableJoinEnforced object.
 int value()
          Returns the int value of this TableJoinEnforced object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_notEnforced

public static final int _notEnforced
Not enforced.

The link is used only if it's explicitly required by the Select statement. You can create reports based on the selected tables without restriction (that is, without enforcement based on other tables).

See Also:
Constant Field Values

_from

public static final int _from
Enforced from.

If the target table of the link is used, the link is enforced. For example, if you create a link from TableA to TableB using Enforce From and select only a field from TableB, the Select statement will still include the join to TableA because it is enforced. Conversely, selecting only from TableA with the same join condition will not cause the join to TableB to be enforced.

See Also:
Constant Field Values

_to

public static final int _to
Enforced to.

If the source table for the link is used, the link is enforced. For example, if you create a link from TableA to TableB using Enforce To and select only a field from TableA, the join to TableB will be enforced, and the Select statement that is generated will include both tables.

See Also:
Constant Field Values

_both

public static final int _both
Enforced both.

If the source table for the link is used, the link is enforced. For example, if you create a link from TableA to TableB using Enforce To and select only a field from TableA, the join to TableB will be enforced, and the Select statement that is generated will include both tables.

See Also:
Constant Field Values

notEnforced

public static final TableJoinEnforced notEnforced
A TableJoinEnforced object that specifies option "Not Enforced".

The link is used only if it's explicitly required by the Select statement. You can create reports based on the selected tables without restriction (that is, without enforcement based on other tables).


from

public static final TableJoinEnforced from
A TableJoinEnforced object that specifies option "Enforced From".

If the target table of the link is used, the link is enforced. For example, if you create a link from TableA to TableB using Enforce From and select only a field from TableB, the Select statement will still include the join to TableA because it is enforced. Conversely, selecting only from TableA with the same join condition will not cause the join to TableB to be enforced.


to

public static final TableJoinEnforced to
A TableJoinEnforced object that specifies option "Enforced To".

If the source table for the link is used, the link is enforced. For example, if you create a link from TableA to TableB using Enforce To and select only a field from TableA, the join to TableB will be enforced, and the Select statement that is generated will include both tables.


both

public static final TableJoinEnforced both
A TableJoinEnforced object that specifies option "Enforced Both".

If the source table for the link is used, the link is enforced. For example, if you create a link from TableA to TableB using Enforce To and select only a field from TableA, the join to TableB will be enforced, and the Select statement that is generated will include both tables.

Method Detail

from_int

public static final TableJoinEnforced from_int(int i)
Returns the TableJoinEnforced object corresponding to the specified int.

Parameters:
i - The int value of the desired TableJoinEnforced object.
Returns:
The TableJoinEnforced object corresponding to the specified int.

from_string

public static final TableJoinEnforced from_string(java.lang.String type)
Returns the TableJoinEnforced object corresponding to the specified String.

Parameters:
type - The String value of the desired TableJoinEnforced object.
Returns:
The TableJoinEnforced object corresponding to the specified String.

toString

public java.lang.String toString()
Returns the String value of this TableJoinEnforced object.

Overrides:
toString in class java.lang.Object
Returns:
The String value of this TableJoinEnforced object.

value

public int value()
Returns the int value of this TableJoinEnforced object.

Returns:
The int value of this TableJoinEnforced object.