public interface TableProviderControl
Modifier and Type | Method and Description |
---|---|
void |
clearRetryCount()
This will set the failedRetryCount to zero.
|
void |
delete(java.lang.String remappedName)
Delete the table with this ID.
|
void |
disableAllAndRestart()
When a condition arises where the table provider is unable to service any of tables, but it does not wish
to have its tables removed from the system.
|
CatalogedTable |
getTable(java.lang.String remappedName)
Find the Table with this ID.
|
java.util.Collection<CatalogedTable> |
getTables()
Get a collection of all the CatalogedTables that belong to your TableProvider.
|
void |
insert(CatalogedTable catalogedTable)
Insert this Table.
|
java.io.File |
locateFile(java.lang.String filename,
boolean required)
This will attempt to locate a file within the project.
|
void |
setEnabled(java.lang.String tableId,
boolean enabled)
Change the enabled state of an existing table.
|
void |
shutMeDown()
Shut down the associated TableProvider.
|
void |
update(CatalogedTable catalogedTable)
Update this Table.
|
void |
upsert(CatalogedTable catalogedTable)
Insert or Update the Table, depending on whether or not it already exists.
|
void setEnabled(java.lang.String tableId, boolean enabled) throws LiveViewException
tableId
- The ID of the Table to change.enabled
- The new state to change it to.LiveViewException
- if attempting to set a table that does not exist enabled. (Setting a non-existant table disabled is ignored.)CatalogedTable getTable(java.lang.String remappedName)
remappedName
- The ID by which the table is saved (i.e. the remapped name)java.util.Collection<CatalogedTable> getTables()
void insert(CatalogedTable catalogedTable)
catalogedTable
- The Table to insert. Note that the catalogedTable will be copied
so further changes to it will not affect anything until you update or upsert.void update(CatalogedTable catalogedTable)
catalogedTable
- The Table to insert. Note that the catalogedTable will be copied
so further changes to it will not affect anything until you update or upsert.void upsert(CatalogedTable catalogedTable)
catalogedTable
- The Table to insert. Note that the catalogedTable will be copied
so further changes to it will not affect anything until you update or upsert.void delete(java.lang.String remappedName)
remappedName
- void shutMeDown()
void disableAllAndRestart()
void clearRetryCount()
java.io.File locateFile(java.lang.String filename, boolean required) throws LiveViewException
filename
- indicates a file in the LiveView projectrequired
- if true, this method will throw an exception if the file can't be found.LiveViewException
- thrown if the required flag was true and either filename was empty or it couldn't find the file.