com.sl.gmsjrtviewds
Class GmsRtViewDsControlProperties

java.lang.Object
  com.sl.gmsjrtviewds.GmsRtViewDsControlProperties

All Implemented Interfaces:

java.lang.Cloneable

public class GmsRtViewDsControlProperties
extends java.lang.Object
implements java.lang.Cloneable

This class contains supplemental metadata that describes an Enterprise RTView Data Adapter, including descriptive information, the names of auxiliary classes and files, available datasource behaviors, and localization information. The control properties are set during initialization, in the method GmsRtViewDs.initDsControlProperties(), and cannot be changed after initialization is complete. Note that the control properties are initialized after command-line arguments and ds options have been processed, so the information from these sources may be used to customize the behavior of the data adapter.

Method Summary

protected java.lang.Object	clone()
void	enableUpdateModes(java.util.Set updateModes) Set the update modes to be enabled for this data source.
java.lang.String	getAttachDataDialogClassName() Get the class name of the attach to data dialog for this datasource.
java.lang.String	getCommandDialogClassName() Get the class name of the define command dialog for this datasource.
java.util.Set	getEnabledUpdateModes() Return the set of enabled update modes for this datasource.
java.lang.String	getOptionTabClassName() Get the class name of the option tab dialog for this datasource.
java.lang.String	getResourceBundleName() Get the name of the resource bundle used to localize the dialogs associated with this datasource.
boolean	isColumnFilteringEnabled() Return a flag indicating whether this data source allows column filtering.
boolean	isCommandsEnabled() Return a flag indicating whether the datasource allows commands.
boolean	isRowFilteringEnabled() Return a flag indicating whether this data source allows row filtering.
void	setAttachDataDialogClassName(java.lang.String className) Set the class name of the attach to data dialog for this datasource.
void	setColumnFilteringEnabled(boolean flag) Set a flag indicating whether this data source allows column filtering.
void	setCommandDialogClassName(java.lang.String className) Set the class name of the define command dialog for this datasource.
void	setCommandsEnabled(boolean flag) Set a flag indicating whether the datasource allows commands.
void	setOptionTabClassName(java.lang.String className) Set the class name of the option tab dialog for this datasource.
void	setResourceBundleName(java.lang.String resourceBundleName) Set the name of the resource bundle used to localize the dialogs associated with this datasource.
void	setRowFilteringEnabled(boolean flag) Set a flag indicating whether this data source allows row filtering.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

enableUpdateModes

public void enableUpdateModes(java.util.Set updateModes)

Set the update modes to be enabled for this data source. The available update modes are defined in the GmsRtViewDs.UpdateMode enum.

Parameters:

updateModes - the Set<GmsRtViewDs.UpdateMode> of update modes to be enabled.

getAttachDataDialogClassName

public java.lang.String getAttachDataDialogClassName()

Get the class name of the attach to data dialog for this datasource. If this method returns null, the default attach to data dialog is used.

Returns:

the class name of the attach to data dialog

getCommandDialogClassName

public java.lang.String getCommandDialogClassName()

Get the class name of the define command dialog for this datasource. If this method returns null, the default define command dialog is used.

Returns:

the class name of the define command dialog

getEnabledUpdateModes

public java.util.Set getEnabledUpdateModes()

Return the set of enabled update modes for this datasource. The available update modes are defined in the GmsRtViewDs.UpdateMode enum.

Returns:

The Set<GmsRtViewDs.UpdateMode> of enabled update modes for this datasource.

getOptionTabClassName

public java.lang.String getOptionTabClassName()

Get the class name of the option tab dialog for this datasource. If this method returns null, the default option tab dialog is used.

Returns:

the class name of the option tab

getResourceBundleName

public java.lang.String getResourceBundleName()

Get the name of the resource bundle used to localize the dialogs associated with this datasource. If a null string is returned, the default custom ds resource bundle will be used.

Returns:

the name of the resource bundle

isColumnFilteringEnabled

public boolean isColumnFilteringEnabled()

Return a flag indicating whether this data source allows column filtering.

Returns:

the enabled status for column filtering

isCommandsEnabled

public boolean isCommandsEnabled()

Return a flag indicating whether the datasource allows commands.

Returns:

the enabled status for commands

isRowFilteringEnabled

public boolean isRowFilteringEnabled()

Return a flag indicating whether this data source allows row filtering.

Returns:

the enabled status for row filtering

setAttachDataDialogClassName

public void setAttachDataDialogClassName(java.lang.String className)

Set the class name of the attach to data dialog for this datasource. If the className argument is null, the default attach to data dialog is used.

Parameters:

className - the class name of the attach to data dialog

setColumnFilteringEnabled

public void setColumnFilteringEnabled(boolean flag)

Set a flag indicating whether this data source allows column filtering.

Parameters:

flag - the enabled status for column filtering

setCommandDialogClassName

public void setCommandDialogClassName(java.lang.String className)

Set the class name of the define command dialog for this datasource. If the className argument is null, the default define command dialog is used.

Parameters:

className - the class name of the define command dialog

setCommandsEnabled

public void setCommandsEnabled(boolean flag)

Set a flag indicating whether the datasource allows commands.

Parameters:

flag - the enabled status for commands

setOptionTabClassName

public void setOptionTabClassName(java.lang.String className)

Set the class name of the option tab dialog for this datasource. If the className argument is null, the default option tab dialog is used.

Parameters:

className - the class name of the option tab

setResourceBundleName

public void setResourceBundleName(java.lang.String resourceBundleName)

Set the name of the resource bundle used to localize the dialogs associated with this datasource. If the resourceBundleName is null, the default custom ds resource bundle will be used.

Parameters:

resourceBundleName - the name of the resource bundle

setRowFilteringEnabled

public void setRowFilteringEnabled(boolean flag)

Set a flag indicating whether this data source allows row filtering.

Parameters:

flag - the enabled status for row filtering

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object