|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.3.0) E17493-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.javatools.data.HashStructureAdapter
oracle.ide.db.transfer.TransferDescriptor
public final class TransferDescriptor
Bean to encapsulte various transfer options to be used as the model for a transfer. A TransferDescriptor can be saved and reused. When a transfer is in process using a given descriptor instance, the artifacts of that transfer (e.g. the copied objects, the reconcile choices etc) are stored in a TransferState
accessible using getTransferState()
.
Field Summary | |
---|---|
static java.lang.String |
KEY |
Fields inherited from class oracle.javatools.data.HashStructureAdapter |
---|
_hash |
Fields inherited from interface oracle.javatools.data.PropertyStorage |
---|
DATA_KEY |
Constructor Summary | |
---|---|
TransferDescriptor() Construct a new TransferDescriptor with default option values. |
|
TransferDescriptor(HashStructure hash) |
Method Summary | ||
---|---|---|
int |
getDependencyDepth() |
|
java.lang.String |
getImportGenerateConn() Deprecated. no longer used. |
|
java.lang.String |
getImportGenerateKey() Deprecated. no longer used. |
|
boolean |
getIncludeAllDependencies() |
|
boolean |
getIncludeDependencies() |
|
java.lang.String |
getName() |
|
DBObjectID[] |
getObjectIDs() Deprecated. |
|
DBObjectID[] |
getObjectIDs(boolean ignorErrors) Gets the DBObjectIDs for the objects chosen for transfer from the source provider. |
|
|
getOrCreateTransferTarget(java.lang.Class<T> targetClass) |
|
java.lang.Class |
getPolicy() |
|
HashStructure |
getProperties() |
|
Step[] |
getReconcilePanels() Deprecated. |
|
SchemaObjectDescriptor[] |
getSchemaObjectDescriptors() |
|
SchemaObject[] |
getSchemaObjects() Deprecated. This method does not let you know that the database connection has been lost. If the caller does not care, use getSchemaObjects( true ) and ignor the exception instead. Otherwise, use getSchemaObjects( false ) and handle the exception |
|
SchemaObject[] |
getSchemaObjects(boolean ignorErrors) Deprecated. use getSystemObjects(boolean) |
|
SchemaObject[] |
getSchemaObjectsAndDependencies() Deprecated. use getSchemaObjectsAndDependencies( boolean ignorErrors ) instead. |
|
SchemaObject[] |
getSchemaObjectsAndDependencies(boolean ignorErrors) Deprecated. use getSystemObjectsAndDependencies(boolean) |
|
Step[] |
getScriptPanels() Deprecated. |
|
java.lang.Object |
getSource() Get the source of the objects to transfer. |
|
java.lang.String |
getSourceApplicationName() Deprecated. - the app/proj are not needed to perform the transfer, just the offlinedb url. |
|
java.lang.String |
getSourceConnectionStore() Deprecated. - the store should be encoded into the identifier |
|
java.lang.String |
getSourceProjectName() Deprecated. - the app/proj are not needed to perform the transfer, just the offlinedb url. |
|
DBObjectProvider |
getSourceProvider() |
|
java.lang.String |
getSourceProviderType() |
|
SystemObject[] |
getSystemObjects() Deprecated. this method does not let the caller know if the database connection is lost. |
|
SystemObject[] |
getSystemObjects(boolean ignorErrors) convenience method to return the source objects. |
|
SystemObject[] |
getSystemObjectsAndDependencies() Deprecated. Use getSystemObjectsAndDependencies( true ) if you dont want to get a DBException. Or better, getSystemObjectsAndDependencies( false ) if the caller will handle the exception. A DBException will be throw if the database connection is lost. |
|
SystemObject[] |
getSystemObjectsAndDependencies(boolean ignorErrors) Convenience method to return the source objects and dependencies. |
|
java.lang.Object |
getTarget() |
|
java.lang.String |
getTargetConnectionStore() Deprecated. - the store should be encoded into the identifier |
|
DBObjectProvider |
getTargetProvider() |
|
java.lang.String |
getTargetProviderType() |
|
java.lang.String |
getTargetSchemaName() |
|
java.lang.String |
getTargetTableSpace() |
|
TransferManager |
getTransferManager() Deprecated. the TransferManager is a singleton - use TransferManager.getInstance() |
|
TransferState |
getTransferState() Gets the current state of the transfer for this descriptor if a transfer is in process, or null if this descriptor has not started to be transferred yet. |
|
|
getTransferTarget(java.lang.Class<T> targetClass) |
|
TransferTarget[] |
getTransferTargets() |
|
TransferState |
initialiseTransferState() This (re)initializes the TransferState object for this descriptor. |
|
boolean |
isCascadeDelete() |
|
boolean |
isDowngradeOK() Has the user accepted that this tranfer is a downgrade. |
|
boolean |
isManualReconcile() |
|
boolean |
isPlusSqlScript() |
|
boolean |
isReconcile() |
|
boolean |
isReplace() |
|
|
removeTransferTarget(java.lang.Class<T> targetClass) |
|
void |
setCascadeDelete(boolean cascadeDelete) |
|
void |
setDependencyDepth(int dependencyDepth) |
|
void |
setDowngradeOK(boolean downgradeOK) Note that the user has accepted the the transfer is a downgrade. |
|
void |
setImportGenerateConn(java.lang.String importGenerateConn) Deprecated. no longer used. |
|
void |
setImportGenerateKey(java.lang.String importGenerateKey) Deprecated. no longer used. |
|
void |
setIncludeAllDependencies(boolean includeAllDependencies) |
|
void |
setIncludeDependencies(boolean includeDependencies) |
|
void |
setManualReconcile(boolean manualReconcile) |
|
void |
setObjectIDs(DBObjectID[] ids) Sets the objects chosen for transfer from the source provider using their DBObejctIDs. |
|
void |
setPlusSqlScrip(boolean plusSqlScrip) |
|
void |
setPolicy(java.lang.Class<? extends TransferPolicy> policy) |
|
void |
setReconcile(boolean reconcile) |
|
void |
setReconcilePanels(Step[] reconcilePanels) Deprecated. |
|
void |
setReplace(boolean replace) |
|
void |
setSchemaObjectDescriptors(SchemaObjectDescriptor[] sos) |
|
void |
setScriptPanels(Step[] scriptPanels) Deprecated. |
|
void |
setSource(java.lang.Object source) Set the source of the objects to transfer. |
|
void |
setSourceApplicationName(java.lang.String source) Deprecated. - the app/proj are not needed to perform the transfer, just the offlinedb url. |
|
void |
setSourceConnectionStore(java.lang.String source) Deprecated. the store should be encoded into the identifier |
|
void |
setSourceProjectName(java.lang.String source) Deprecated. - the app/proj are not needed to perform the transfer, just the offlinedb url. |
|
void |
setSourceProvider(DBObjectProvider pro) |
|
void |
setSourceProviderType(java.lang.String providerType) |
|
void |
setTarget(java.lang.Object obj) |
|
void |
setTargetConnectionStore(java.lang.String target) Deprecated. the conn store is encoded into the provider id |
|
void |
setTargetProvider(DBObjectProvider pro) |
|
void |
setTargetProviderType(java.lang.String providerType) |
|
void |
setTargetSchemaName(java.lang.String schemaName) |
|
void |
setTargetTableSpace(java.lang.String schemaName) |
Methods inherited from class oracle.javatools.data.HashStructureAdapter |
---|
addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String KEY
Constructor Detail |
---|
public TransferDescriptor()
TransferDescriptor
with default option values.public TransferDescriptor(HashStructure hash)
Method Detail |
---|
public java.lang.String getName()
public TransferState initialiseTransferState()
public TransferState getTransferState()
public DBObjectID[] getObjectIDs(boolean ignorErrors) throws TransferFailedException
ignorErrors
- whether to ignore errors in retrieving the ids.DBException
- if the source provider, or the objects to transfer, cannot be retrieved.TransferFailedException
public void setObjectIDs(DBObjectID[] ids)
public boolean isReplace()
public void setReplace(boolean replace)
public boolean isCascadeDelete()
public void setCascadeDelete(boolean cascadeDelete)
public boolean isReconcile()
public void setReconcile(boolean reconcile)
public boolean isManualReconcile()
public void setManualReconcile(boolean manualReconcile)
public java.lang.String getTargetSchemaName()
public void setTargetSchemaName(java.lang.String schemaName)
public java.lang.String getTargetTableSpace()
public void setTargetTableSpace(java.lang.String schemaName)
public void setTarget(java.lang.Object obj)
public java.lang.Object getTarget()
public void setTargetProviderType(java.lang.String providerType)
public java.lang.String getTargetProviderType()
public DBObjectProvider getTargetProvider() throws TransferFailedException
TransferFailedException
public void setTargetProvider(DBObjectProvider pro)
public void setSchemaObjectDescriptors(SchemaObjectDescriptor[] sos)
public SchemaObjectDescriptor[] getSchemaObjectDescriptors()
public boolean getIncludeDependencies()
public void setIncludeDependencies(boolean includeDependencies)
public boolean getIncludeAllDependencies()
public void setIncludeAllDependencies(boolean includeAllDependencies)
public int getDependencyDepth()
public void setDependencyDepth(int dependencyDepth)
public boolean isPlusSqlScript()
public void setPlusSqlScrip(boolean plusSqlScrip)
public boolean isDowngradeOK()
public void setDowngradeOK(boolean downgradeOK)
public void setSource(java.lang.Object source)
public java.lang.Object getSource()
DBObjectProvider.getProviderIdentifier()
public void setSourceProviderType(java.lang.String providerType)
public java.lang.String getSourceProviderType()
public void setSourceProvider(DBObjectProvider pro)
public DBObjectProvider getSourceProvider() throws TransferFailedException
TransferFailedException
public void setPolicy(java.lang.Class<? extends TransferPolicy> policy)
public java.lang.Class getPolicy()
public TransferTarget[] getTransferTargets()
public <T extends TransferTarget> T getTransferTarget(java.lang.Class<T> targetClass)
public <T extends TransferTarget> T getOrCreateTransferTarget(java.lang.Class<T> targetClass)
public <T extends TransferTarget> T removeTransferTarget(java.lang.Class<T> targetClass)
public SystemObject[] getSystemObjects(boolean ignorErrors) throws TransferFailedException
ignorErrors
- If true, DBExceptions are ignored.TransferFailedException
public SystemObject[] getSystemObjectsAndDependencies(boolean ignorErrors) throws TransferFailedException
ignorErrors
- - if true, this method will swallow DBExceptionsTransferFailedException
public HashStructure getProperties()
getProperties
in interface PropertyStorage
HashStructure
wrapped by this PropertyStorage.
@Deprecated
public void setReconcilePanels(Step[] reconcilePanels)
@Deprecated
public Step[] getReconcilePanels()
@Deprecated
public void setScriptPanels(Step[] scriptPanels)
@Deprecated
public Step[] getScriptPanels()
@Deprecated
public TransferManager getTransferManager()
TransferManager.getInstance()
@Deprecated
public SchemaObject[] getSchemaObjectsAndDependencies()
@Deprecated
public DBObjectID[] getObjectIDs()
@Deprecated
public SchemaObject[] getSchemaObjects()
@Deprecated
public SystemObject[] getSystemObjects()
@Deprecated
public SystemObject[] getSystemObjectsAndDependencies()
@Deprecated
public SchemaObject[] getSchemaObjects(boolean ignorErrors)
throws TransferFailedException
getSystemObjects(boolean)
TransferFailedException
@Deprecated
public SchemaObject[] getSchemaObjectsAndDependencies(boolean ignorErrors)
throws TransferFailedException
getSystemObjectsAndDependencies(boolean)
TransferFailedException
@Deprecated
public void setImportGenerateKey(java.lang.String importGenerateKey)
@Deprecated
public java.lang.String getImportGenerateKey()
@Deprecated
public void setImportGenerateConn(java.lang.String importGenerateConn)
@Deprecated
public java.lang.String getImportGenerateConn()
@Deprecated
public void setTargetConnectionStore(java.lang.String target)
@Deprecated
public java.lang.String getTargetConnectionStore()
@Deprecated
public void setSourceApplicationName(java.lang.String source)
@Deprecated
public java.lang.String getSourceApplicationName()
@Deprecated
public void setSourceProjectName(java.lang.String source)
@Deprecated
public java.lang.String getSourceProjectName()
@Deprecated
public void setSourceConnectionStore(java.lang.String source)
@Deprecated
public java.lang.String getSourceConnectionStore()
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.3.0) E17493-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |