ExternalConnection (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.ExternalConnection

Direct Known Subclasses:

DataModelConnection, DBConnection, WebQueryConnection
```
public abstract class ExternalConnection
extends java.lang.Object
```
Specifies an external data connection

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getBackgroundRefresh()` Indicates whether the connection can be refreshed in the background (asynchronously).
`abstract int`	`getClassType()` Gets the type of this `ExternalConnection` object.
`java.lang.String`	`getCommand()` The string containing the database command to pass to the data provider API that will interact with the external source in order to retrieve data
`int`	`getCommandType()` Specifies the OLE DB command type.
`java.lang.String`	`getConnectionDescription()` Specifies the user description for this connection
`java.lang.String`	`getConnectionFile()` Gets the connection file.
`int`	`getConnectionId()` Deprecated. Use ExternalConnection.Id property instead.
`java.lang.String`	`getConnectionString()` The connection information string is used to make contact with an OLE DB or ODBC data source.
`int`	`getCredentials()` Deprecated. Use ExternalConnection.CredentialsMethodType property instead.
`int`	`getCredentialsMethodType()` Specifies the authentication method to be used when establishing (or re-establishing) the connection.
`int`	`getId()` Gets the id of the connection.
`boolean`	`getKeepAlive()` True when the spreadsheet application should make efforts to keep the connection open.
`java.lang.String`	`getName()` Specifies the name of the connection.
`java.lang.String`	`getOdcFile()` Specifies the full path to external connection file from which this connection was created.
`boolean`	`getOnlyUseConnectionFile()` Indicates whether the spreadsheet application should always and only use the connection information in the external connection file indicated by the odcFile attribute when the connection is refreshed.
`ConnectionParameterCollection`	`getParameters()` Gets `ConnectionParameterCollection` for an ODBC or web query.
`PowerQueryFormula`	`getPowerQueryFormula()` Gets the definition of power query formula.
`int`	`getReconnectionMethod()` Deprecated. Use ExternalConnection.ReconnectionMethodType property instead.
`int`	`getReconnectionMethodType()` Specifies what the spreadsheet application should do when a connection fails.
`int`	`getRefreshInternal()` Specifies the number of minutes between automatic refreshes of the connection.
`boolean`	`getRefreshOnLoad()` True if this connection should be refreshed when opening the file; otherwise, false.
`boolean`	`getSaveData()` True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false.
`boolean`	`getSavePassword()` True if the password is to be saved as part of the connection string; otherwise, False.
`java.lang.String`	`getSecondCommand()` Specifies a second command text string that is persisted when PivotTable server-based page fields are in use.
`java.lang.String`	`getSourceFile()` Used when the external data source is file-based.
`int`	`getSourceType()` Gets the external connection DataSource type.
`java.lang.String`	`getSSOId()` Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source.
`int`	`getType()` Deprecated. Use ExternalConnection.SourceType property instead.
`boolean`	`isDeleted()` Indicates whether the associated workbook connection has been deleted.
`boolean`	`isNew()` True if the connection has not been refreshed for the first time; otherwise, false.
`void`	`setBackgroundRefresh(boolean value)` Indicates whether the connection can be refreshed in the background (asynchronously).
`void`	`setCommand(java.lang.String value)` The string containing the database command to pass to the data provider API that will interact with the external source in order to retrieve data
`void`	`setCommandType(int value)` Specifies the OLE DB command type.
`void`	`setConnectionDescription(java.lang.String value)` Specifies the user description for this connection
`void`	`setConnectionString(java.lang.String value)` The connection information string is used to make contact with an OLE DB or ODBC data source.
`void`	`setCredentials(int value)` Deprecated. Use ExternalConnection.CredentialsMethodType property instead.
`void`	`setCredentialsMethodType(int value)` Specifies the authentication method to be used when establishing (or re-establishing) the connection.
`void`	`setDeleted(boolean value)` Indicates whether the associated workbook connection has been deleted.
`void`	`setKeepAlive(boolean value)` True when the spreadsheet application should make efforts to keep the connection open.
`void`	`setName(java.lang.String value)` Specifies the name of the connection.
`void`	`setNew(boolean value)` True if the connection has not been refreshed for the first time; otherwise, false.
`void`	`setOdcFile(java.lang.String value)` Specifies the full path to external connection file from which this connection was created.
`void`	`setOnlyUseConnectionFile(boolean value)` Indicates whether the spreadsheet application should always and only use the connection information in the external connection file indicated by the odcFile attribute when the connection is refreshed.
`void`	`setReconnectionMethod(int value)` Deprecated. Use ExternalConnection.ReconnectionMethodType property instead.
`void`	`setReconnectionMethodType(int value)` Specifies what the spreadsheet application should do when a connection fails.
`void`	`setRefreshInternal(int value)` Specifies the number of minutes between automatic refreshes of the connection.
`void`	`setRefreshOnLoad(boolean value)` True if this connection should be refreshed when opening the file; otherwise, false.
`void`	`setSaveData(boolean value)` True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false.
`void`	`setSavePassword(boolean value)` True if the password is to be saved as part of the connection string; otherwise, False.
`void`	`setSecondCommand(java.lang.String value)` Specifies a second command text string that is persisted when PivotTable server-based page fields are in use.
`void`	`setSourceFile(java.lang.String value)` Used when the external data source is file-based.
`void`	`setSourceType(int value)` Sets the external connection DataSource type.
`void`	`setSSOId(java.lang.String value)` Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source.
`void`	`setType(int value)` Deprecated. Use ExternalConnection.SourceType property instead.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getId
```
public int getId()
```
    Gets the id of the connection.
  - getConnectionId
```
public int getConnectionId()
```
    Deprecated. Use ExternalConnection.Id property instead.
    
    Specifies The unique identifier of this connection.
    Remarks
    NOTE: This property is now obsolete. Instead, please use ExternalConnection.Id property. This property will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.
  - getClassType
```
public abstract int getClassType()
```
    Gets the type of this ExternalConnection object.
    See ExternalConnectionClassType.
  - getPowerQueryFormula
```
public PowerQueryFormula getPowerQueryFormula()
```
    Gets the definition of power query formula.
  - getType
```
public int getType()
```
    Deprecated. Use ExternalConnection.SourceType property instead.
    
    Gets the external connection DataSource type.
    See ConnectionDataSourceType.
    
    Remarks
    NOTE: This property is now obsolete. Instead, please use ExternalConnection.SourceType property. This property will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.
  - setType
```
public void setType(int value)
```
    Deprecated. Use ExternalConnection.SourceType property instead.
    
    Sets the external connection DataSource type.
    See ConnectionDataSourceType.
    
    Remarks
    NOTE: This property is now obsolete. Instead, please use ExternalConnection.SourceType property. This property will be removed 12 months later since October 2024. Aspose apologizes for any inconvenience you may have experienced.
  - getSourceType
```
public int getSourceType()
```
    Gets the external connection DataSource type.
    See ConnectionDataSourceType.
  - setSourceType
```
public void setSourceType(int value)
```
    Sets the external connection DataSource type.
    See ConnectionDataSourceType.
  - getSSOId
```
public java.lang.String getSSOId()
```
    Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source.
  - setSSOId
```
public void setSSOId(java.lang.String value)
```
    Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source.
  - getSavePassword
```
public boolean getSavePassword()
```
    True if the password is to be saved as part of the connection string; otherwise, False.
  - setSavePassword
```
public void setSavePassword(boolean value)
```
    True if the password is to be saved as part of the connection string; otherwise, False.
  - getSaveData
```
public boolean getSaveData()
```
    True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false.
  - setSaveData
```
public void setSaveData(boolean value)
```
    True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false.
  - getRefreshOnLoad
```
public boolean getRefreshOnLoad()
```
    True if this connection should be refreshed when opening the file; otherwise, false.
  - setRefreshOnLoad
```
public void setRefreshOnLoad(boolean value)
```
    True if this connection should be refreshed when opening the file; otherwise, false.
  - getReconnectionMethodType
```
public int getReconnectionMethodType()
```
    Specifies what the spreadsheet application should do when a connection fails. The default value is ReConnectionMethodType.Required.
    See ReConnectionMethodType.
  - setReconnectionMethodType
```
public void setReconnectionMethodType(int value)
```
    Specifies what the spreadsheet application should do when a connection fails. The default value is ReConnectionMethodType.Required.
    See ReConnectionMethodType.
  - getReconnectionMethod
```
public int getReconnectionMethod()
```
    Deprecated. Use ExternalConnection.ReconnectionMethodType property instead.
    
    Specifies what the spreadsheet application should do when a connection fails. The default value is ReConnectionMethodType.Required.
    See ReConnectionMethodType.
    
    Remarks
    NOTE: This property is now obsolete. Instead, please use ExternalConnection.ReconnectionMethodType property. This property will be removed 12 months later since October 2017. Aspose apologizes for any inconvenience you may have experienced.
  - setReconnectionMethod
```
public void setReconnectionMethod(int value)
```
    Deprecated. Use ExternalConnection.ReconnectionMethodType property instead.
    
    Specifies what the spreadsheet application should do when a connection fails. The default value is ReConnectionMethodType.Required.
    See ReConnectionMethodType.
    
    Remarks
    NOTE: This property is now obsolete. Instead, please use ExternalConnection.ReconnectionMethodType property. This property will be removed 12 months later since October 2017. Aspose apologizes for any inconvenience you may have experienced.
  - getOnlyUseConnectionFile
```
public boolean getOnlyUseConnectionFile()
```
    Indicates whether the spreadsheet application should always and only use the connection information in the external connection file indicated by the odcFile attribute when the connection is refreshed. If false, then the spreadsheet application should follow the procedure indicated by the reconnectionMethod attribute
  - setOnlyUseConnectionFile
```
public void setOnlyUseConnectionFile(boolean value)
```
    Indicates whether the spreadsheet application should always and only use the connection information in the external connection file indicated by the odcFile attribute when the connection is refreshed. If false, then the spreadsheet application should follow the procedure indicated by the reconnectionMethod attribute
  - getOdcFile
```
public java.lang.String getOdcFile()
```
    Specifies the full path to external connection file from which this connection was created. If a connection fails during an attempt to refresh data, and reconnectionMethod=1, then the spreadsheet application will try again using information from the external connection file instead of the connection object embedded within the workbook.
  - setOdcFile
```
public void setOdcFile(java.lang.String value)
```
    Specifies the full path to external connection file from which this connection was created. If a connection fails during an attempt to refresh data, and reconnectionMethod=1, then the spreadsheet application will try again using information from the external connection file instead of the connection object embedded within the workbook.
  - getSourceFile
```
public java.lang.String getSourceFile()
```
    Used when the external data source is file-based. When a connection to such a data source fails, the spreadsheet application attempts to connect directly to this file. May be expressed in URI or system-specific file path notation.
  - setSourceFile
```
public void setSourceFile(java.lang.String value)
```
    Used when the external data source is file-based. When a connection to such a data source fails, the spreadsheet application attempts to connect directly to this file. May be expressed in URI or system-specific file path notation.
  - getConnectionFile
```
public java.lang.String getConnectionFile()
```
    Gets the connection file.
  - isNew
```
public boolean isNew()
```
    True if the connection has not been refreshed for the first time; otherwise, false. This state can happen when the user saves the file before a query has finished returning.
  - setNew
```
public void setNew(boolean value)
```
    True if the connection has not been refreshed for the first time; otherwise, false. This state can happen when the user saves the file before a query has finished returning.
  - getName
```
public java.lang.String getName()
```
    Specifies the name of the connection. Each connection must have a unique name.
  - setName
```
public void setName(java.lang.String value)
```
    Specifies the name of the connection. Each connection must have a unique name.
  - getKeepAlive
```
public boolean getKeepAlive()
```
    True when the spreadsheet application should make efforts to keep the connection open. When false, the application should close the connection after retrieving the information.
  - setKeepAlive
```
public void setKeepAlive(boolean value)
```
    True when the spreadsheet application should make efforts to keep the connection open. When false, the application should close the connection after retrieving the information.
  - getRefreshInternal
```
public int getRefreshInternal()
```
    Specifies the number of minutes between automatic refreshes of the connection.
  - setRefreshInternal
```
public void setRefreshInternal(int value)
```
    Specifies the number of minutes between automatic refreshes of the connection.
  - getConnectionDescription
```
public java.lang.String getConnectionDescription()
```
    Specifies the user description for this connection
  - setConnectionDescription
```
public void setConnectionDescription(java.lang.String value)
```
    Specifies the user description for this connection
  - isDeleted
```
public boolean isDeleted()
```
    Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false.
  - setDeleted
```
public void setDeleted(boolean value)
```
    Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false.
  - getCredentialsMethodType
```
public int getCredentialsMethodType()
```
    Specifies the authentication method to be used when establishing (or re-establishing) the connection.
    See CredentialsMethodType.
  - setCredentialsMethodType
```
public void setCredentialsMethodType(int value)
```
    Specifies the authentication method to be used when establishing (or re-establishing) the connection.
    See CredentialsMethodType.
  - getCredentials
```
public int getCredentials()
```
    Deprecated. Use ExternalConnection.CredentialsMethodType property instead.
    
    Specifies the authentication method to be used when establishing (or re-establishing) the connection.
    See CredentialsMethodType.
    
    Remarks
    NOTE: This property is now obsolete. Instead, please use ExternalConnection.CredentialsMethodType property. This property will be removed 12 months later since October 2017. Aspose apologizes for any inconvenience you may have experienced.
  - setCredentials
```
public void setCredentials(int value)
```
    Deprecated. Use ExternalConnection.CredentialsMethodType property instead.
    
    Specifies the authentication method to be used when establishing (or re-establishing) the connection.
    See CredentialsMethodType.
    
    Remarks
    NOTE: This property is now obsolete. Instead, please use ExternalConnection.CredentialsMethodType property. This property will be removed 12 months later since October 2017. Aspose apologizes for any inconvenience you may have experienced.
  - getBackgroundRefresh
```
public boolean getBackgroundRefresh()
```
    Indicates whether the connection can be refreshed in the background (asynchronously). true if preferred usage of the connection is to refresh asynchronously in the background; false if preferred usage of the connection is to refresh synchronously in the foreground.
  - setBackgroundRefresh
```
public void setBackgroundRefresh(boolean value)
```
    Indicates whether the connection can be refreshed in the background (asynchronously). true if preferred usage of the connection is to refresh asynchronously in the background; false if preferred usage of the connection is to refresh synchronously in the foreground.
  - getParameters
```
public ConnectionParameterCollection getParameters()
```
    Gets ConnectionParameterCollection for an ODBC or web query.
  - getCommand
```
public java.lang.String getCommand()
```
    The string containing the database command to pass to the data provider API that will interact with the external source in order to retrieve data
  - setCommand
```
public void setCommand(java.lang.String value)
```
    The string containing the database command to pass to the data provider API that will interact with the external source in order to retrieve data
  - getCommandType
```
public int getCommandType()
```
    Specifies the OLE DB command type. 1. Query specifies a cube name 2. Query specifies a SQL statement 3. Query specifies a table name 4. Query specifies that default information has been given, and it is up to the provider how to interpret. 5. Query is against a web based List Data Provider.
    See OLEDBCommandType.
  - setCommandType
```
public void setCommandType(int value)
```
    Specifies the OLE DB command type. 1. Query specifies a cube name 2. Query specifies a SQL statement 3. Query specifies a table name 4. Query specifies that default information has been given, and it is up to the provider how to interpret. 5. Query is against a web based List Data Provider.
    See OLEDBCommandType.
  - getConnectionString
```
public java.lang.String getConnectionString()
```
    The connection information string is used to make contact with an OLE DB or ODBC data source.
  - setConnectionString
```
public void setConnectionString(java.lang.String value)
```
    The connection information string is used to make contact with an OLE DB or ODBC data source.
  - getSecondCommand
```
public java.lang.String getSecondCommand()
```
    Specifies a second command text string that is persisted when PivotTable server-based page fields are in use. For ODBC connections, serverCommand is usually a broader query than command (no WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), parameter UI can be populated and parameterized queries can be constructed
  - setSecondCommand
```
public void setSecondCommand(java.lang.String value)
```
    Specifies a second command text string that is persisted when PivotTable server-based page fields are in use. For ODBC connections, serverCommand is usually a broader query than command (no WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), parameter UI can be populated and parameterized queries can be constructed

Class ExternalConnection

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getId

getConnectionId

getClassType

getPowerQueryFormula

getType

setType

getSourceType

setSourceType

getSSOId

setSSOId

getSavePassword

setSavePassword

getSaveData

setSaveData

getRefreshOnLoad

setRefreshOnLoad

getReconnectionMethodType

setReconnectionMethodType

getReconnectionMethod

setReconnectionMethod

getOnlyUseConnectionFile

setOnlyUseConnectionFile

getOdcFile

setOdcFile

getSourceFile

setSourceFile

getConnectionFile

isNew

setNew

getName

setName

getKeepAlive

setKeepAlive

getRefreshInternal

setRefreshInternal

getConnectionDescription

setConnectionDescription

isDeleted

setDeleted

getCredentialsMethodType

setCredentialsMethodType

getCredentials

setCredentials

getBackgroundRefresh

setBackgroundRefresh

getParameters

getCommand

setCommand

getCommandType

setCommandType

getConnectionString

setConnectionString

getSecondCommand

setSecondCommand