Oracle Fusion Middleware
Java API Reference for Oracle BPM Suite
11g Release 1 (11.1.1.7.0)
E25378-07

oracle.bpel.services.workflow.repos
Class Column

java.lang.Object
  extended by oracle.bpel.services.workflow.repos.Column
All Implemented Interfaces:
java.io.Serializable

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

This class represents a column in the table that is related to an attribute of the task object. This is an internal class and objects of this type are available as constants, such as TableConstants.WFTASK_STATE_COLUMN. Users should be using these objects to query tasks.

See Also:
Serialized Form

Constructor Summary
Column(java.lang.String name, int type, oracle.bpel.services.workflow.repos.Table table)
          Constructor to create a Column object to represent a column in a Workflow services table.
Column(java.lang.String name, java.lang.String alias, int type, boolean translatable, boolean searchable, oracle.bpel.services.workflow.repos.Table table)
           
Column(java.lang.String name, java.lang.String alias, int type, oracle.bpel.services.workflow.repos.Table table)
          Constructor to create a Column object to represent a column in a Workflow services table.
 
Method Summary
 boolean equals(java.lang.Object column)
          Object comparision
 java.lang.String getAlias()
          Returns the column alias
static Column getColumn(java.lang.String columnName)
          getColumn returns the Column object created in TableConstants for the specified columnName using a lookup of the static map.
static Column getColumn(java.lang.String tableName, java.lang.String columnName)
          Returns the column object for the specified table and column names
 java.lang.String getName()
          Returns the name of the column
 oracle.bpel.services.workflow.repos.Table getTable()
          Returns the table that this column object belongs to.
 java.lang.String getTableAlias()
          Returns the alias for the table that this column belongs to.
 java.lang.String getTableName()
          Returns the name of the table this column belongs to
 int getType()
          returns the data type of the column
 boolean isSearchable()
          Returns the value of the searchable flag.
 boolean isStringType()
           
 boolean isTranslatable()
          Returns the value of the translatable flag.
 void setTranslatable(boolean mTranslatable)
          Sets the value of the translatable flag.
 java.lang.String toString()
          returns the string representation of the column name.
 java.lang.String toString(boolean useAlias)
          returns the string representation of the column name.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Column

public Column(java.lang.String name,
              int type,
              oracle.bpel.services.workflow.repos.Table table)
Constructor to create a Column object to represent a column in a Workflow services table.

Parameters:
name - name of the column
type - Data type of the column. String, boolean, integer, etc.
table - The table that this column is presetn

Column

public Column(java.lang.String name,
              java.lang.String alias,
              int type,
              oracle.bpel.services.workflow.repos.Table table)
Constructor to create a Column object to represent a column in a Workflow services table.

Parameters:
name - name of the column
alias - alias of the column
type - Data type of the column. String, boolean, integer, etc.
table - The table that this column is presetn

Column

public Column(java.lang.String name,
              java.lang.String alias,
              int type,
              boolean translatable,
              boolean searchable,
              oracle.bpel.services.workflow.repos.Table table)
Method Detail

getColumn

public static Column getColumn(java.lang.String columnName)
getColumn returns the Column object created in TableConstants for the specified columnName using a lookup of the static map.

Parameters:
columnName - name of the column in WFTASK table
Returns:
Column object

getColumn

public static Column getColumn(java.lang.String tableName,
                               java.lang.String columnName)
Returns the column object for the specified table and column names

Parameters:
tableName - name of the table
columnName - name of the column
Returns:
Column object

getName

public java.lang.String getName()
Returns the name of the column

Returns:

getType

public int getType()
returns the data type of the column

Returns:

isStringType

public boolean isStringType()

getTableName

public java.lang.String getTableName()
Returns the name of the table this column belongs to

Returns:

getAlias

public java.lang.String getAlias()
Returns the column alias

Returns:

getTableAlias

public java.lang.String getTableAlias()
Returns the alias for the table that this column belongs to.

Returns:

getTable

public oracle.bpel.services.workflow.repos.Table getTable()
Returns the table that this column object belongs to.

Returns:

equals

public boolean equals(java.lang.Object column)
Object comparision

Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString(boolean useAlias)
returns the string representation of the column name. Example. "wfn.columnname aliasname" if usealias is true or "wfn.columnname" if alias isfalse

Parameters:
useAlias - use the alias given or not.
Returns:

toString

public java.lang.String toString()
returns the string representation of the column name. Example. "wfn.columnname aliasname"

Overrides:
toString in class java.lang.Object
Returns:

setTranslatable

public void setTranslatable(boolean mTranslatable)
Sets the value of the translatable flag. Setting this will indicate that the column value will not be derrived from the base table but from a related translation table

Parameters:
mTranslatable - The boolean value to set the translation flag.

isTranslatable

public boolean isTranslatable()
Returns the value of the translatable flag. When true, the value for the column should come from a MLS translation table and not the base table to which it is defined.

Returns:
boolean

isSearchable

public boolean isSearchable()
Returns the value of the searchable flag. When true, the column can be used in predicates for task query.

Returns:
boolean

Oracle Fusion Middleware
Java API Reference for Oracle BPM Suite
11g Release 1 (11.1.1.7.0)
E25378-07

Copyright © 2009, 2013, Oracle and/or its affiliates. All rights reserved.