public final class TransferState
extends java.lang.Object
The state contains the transient artifacts of a transfer process (e.g. the objects from the source provider, their copies for transfer, the Difference with reconcile choices etc).
TransferDescriptor.getTransferState()
Modifier and Type | Class and Description |
---|---|
static class |
TransferState.Event
An enumeration of events in the lifecycle of the TransferState.
|
Constructor and Description |
---|
TransferState(TransferDescriptor td) |
Modifier and Type | Method and Description |
---|---|
void |
addMessage(java.lang.String message)
Add a message to the TransferState object for display to the user.
|
void |
addStateListener(TransferStateListener l)
Register a TransferStateListener to be notified of events in the lifecycle of the TransferState.
|
void |
cancel()
Marks this transfer for cancellation.
|
void |
checkNotCancelled()
If this transfer has been marked for cancellation, throws a
TransferCancelledException . |
void |
clearMessages()
Clear all messages for display held on the TransferState object.
|
TransferTarget |
getActiveTarget()
If the transfer is active this returns the target being transferred to.
|
SystemObject[] |
getCopiedObjects()
Gets the "copied" objects for the transfer.
|
TransferDescriptor |
getDescriptor()
Return the TransferDescriptor associated with this TransferState object
|
SystemObject[] |
getExistingObjects()
Gets the "existing" objects for the transfer.
|
java.lang.String[] |
getMessages()
Return all messages for display held on the TransferState object.
|
SystemObject[] |
getOriginalObjects()
Gets the "original" objects for the transfer.
|
TransferPolicy |
getPolicy()
Return the TransferPolicy associated with this TransferState.
|
ResultSet |
getResultSet() |
boolean |
hasFailed()
Returns true if the transfer (or prepare) has failed.
|
boolean |
isPrepDone()
Is the prepare stage of transfer done.
|
boolean |
removeStateListener(TransferStateListener l)
Remove a TransferStateListener previously registered via
addStateListener(oracle.ide.db.transfer.TransferStateListener) . |
void |
setExistingObjects(SystemObject[] existing)
Set the "existing" objects on the TransferState
Should only be used by the TransferManager and RefreshController.
|
void |
setFailed(boolean failed)
Notifies any state listeners that the transfer (or prepare) has failed.
|
void |
setResultSet(ResultSet rs) |
public TransferState(TransferDescriptor td)
public TransferDescriptor getDescriptor()
public boolean isPrepDone()
public TransferTarget getActiveTarget()
public void setFailed(boolean failed)
public boolean hasFailed()
public void cancel()
checkNotCancelled()
will throw a TransferCancelledException
.public void checkNotCancelled() throws TransferCancelledException
TransferCancelledException
. This method will also reset the
cancelled state so that this transfer can be restarted subsequently.
If this transfer has not been marked for cancellation, this method does
nothing.TransferCancelledException
public ResultSet getResultSet()
public void setResultSet(ResultSet rs)
public SystemObject[] getOriginalObjects()
public SystemObject[] getExistingObjects()
public SystemObject[] getCopiedObjects()
public void setExistingObjects(SystemObject[] existing)
public void addMessage(java.lang.String message)
message
- A message to displaypublic java.lang.String[] getMessages()
public void clearMessages()
public TransferPolicy getPolicy()
public void addStateListener(TransferStateListener l)
NB - can also register via the extension.xml, for example:
<database-transfer-hook xmlns="http://xmlns.oracle.com/ide/extension/db"> ... <transfer-state-listeners> <transfer-state-listener> <source-provider-type>db</source-provider-type> <target-id>offlinedb</target-id> <class>com.example.MyTransferStateListener</class> </transfer-state-listener> </transfer-state-listeners> ... </database-transfer-hook>
public boolean removeStateListener(TransferStateListener l)
addStateListener(oracle.ide.db.transfer.TransferStateListener)
.l
- the listener to remove