com.simba.dsi.core.utilities
Class ConnectionSetting

java.lang.Object
  extended by com.simba.dsi.core.utilities.ConnectionSetting

public class ConnectionSetting
extends java.lang.Object

Defines options for connection settings transmitted between DSI and ODBCFunctionality. These connection settings options include a settings type, a label, and value(s) for the setting. This is a mechanism for the data source to respond to a given set of proposed connection setting when the application wishes to establishes a connection with the data source. Data source will use ConnectionSetting to respond to the data source to request for more connection setting information or to notify that a connection setting has been changed and substituted with another value.


Field Summary
static int TYPE_OPTIONAL
          Constant for specifying the status of this connection setting to be optional.
static int TYPE_PROCESSED
          Constant for specifying the status of this connection setting to be already processed.
static int TYPE_REQUIRED
          Constant for specifying the status of this connection setting to be required.
 
Constructor Summary
ConnectionSetting(int status)
          Constructs an empty ConnectionSetting with a particular status, empty label, and empty values.
 
Method Summary
 java.lang.String getLabel()
          Retrieves the label of this connection setting.
 int getStatus()
          Retrieves the status of this connection setting.
 java.util.ArrayList<Variant> getValues()
          Retrieves the values of this connection setting.
 void insertValue(Variant value)
          Inserts a value into the list of values of this connection setting.
 boolean isOptional()
          Indicates if this is an optional setting.
 boolean isProcessed()
          Indicates if this is a processed setting.
 boolean isRequired()
          Indicates if this is a required setting.
 void setLabel(java.lang.String label)
          Sets the label of this connection setting.
 void setValues(java.util.ArrayList<Variant> values)
          Sets the values of this connection setting.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE_OPTIONAL

public static final int TYPE_OPTIONAL
Constant for specifying the status of this connection setting to be optional.

See Also:
Constant Field Values

TYPE_REQUIRED

public static final int TYPE_REQUIRED
Constant for specifying the status of this connection setting to be required.

See Also:
Constant Field Values

TYPE_PROCESSED

public static final int TYPE_PROCESSED
Constant for specifying the status of this connection setting to be already processed.

See Also:
Constant Field Values
Constructor Detail

ConnectionSetting

public ConnectionSetting(int status)
Constructs an empty ConnectionSetting with a particular status, empty label, and empty values. Needs value(s) and label to be set in order to be a useful connection setting.

Parameters:
status - Status if this ConnectionSetting.
Method Detail

getLabel

public java.lang.String getLabel()
Retrieves the label of this connection setting.

Returns:
Label of this connection setting

getStatus

public int getStatus()
Retrieves the status of this connection setting.

Returns:
Status of this connection setting.

getValues

public java.util.ArrayList<Variant> getValues()
Retrieves the values of this connection setting.

Returns:
An ArrayList of Variants, holding values of this connection setting.
See Also:
Variant

insertValue

public void insertValue(Variant value)
Inserts a value into the list of values of this connection setting.

Parameters:
value - Value that is inserted into the list of values of this connection setting.
See Also:
Variant

isOptional

public boolean isOptional()
Indicates if this is an optional setting.

Returns:
true if this is an optional setting; false otherwise.

isProcessed

public boolean isProcessed()
Indicates if this is a processed setting.

Returns:
true if this is a processed setting; false otherwise.

isRequired

public boolean isRequired()
Indicates if this is a required setting.

Returns:
true if this is a required setting; false otherwise.

setLabel

public void setLabel(java.lang.String label)
Sets the label of this connection setting.

Parameters:
label - Label of this connection setting.

setValues

public void setValues(java.util.ArrayList<Variant> values)
Sets the values of this connection setting. Previous values are dropped.

Parameters:
values - Values of this connection setting. An ArrayList of Variants.
See Also:
Variant


Copyright © 2006-2014 Simba Technologies Incorporated. All Rights Reserved.