oracle.streams

Interface DDLLCR

All Superinterfaces:

LCR

All Known Implementing Classes:

DefaultDDLLCR

public interface DDLLCR
extends LCR

The DDLLCR interface encapsulates the information about a DDL LCR. A DDL LCR is a logical change record for a DDL operation. You can have a customized implementation of DDLLCR by using this interface.

See Also:

AbstractLCR, RowLCR

Field Summary

Fields inherited from interface oracle.streams.LCR

ATTRIBUTE_ROOT_NAME, ATTRIBUTE_ROW_ID, ATTRIBUTE_SERIAL_NUM, ATTRIBUTE_SESSION_NUM, ATTRIBUTE_THREAD_NUM, ATTRIBUTE_TX_NAME, ATTRIBUTE_USERNAME

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBaseTableName() Gets the base table name.
java.lang.String	getBaseTableOwner() Gets the base table owner.
java.lang.String	getCurrentSchema() Gets the current schema name.
java.lang.String	getDDLText() Gets the DDL statement text.
java.lang.String	getEditionName() Gets the edition name.
java.lang.String	getLogonUser() Gets the logon user name.
java.lang.String	getObjectType() Gets the object type.
void	setBaseTableName(java.lang.String baseTableName) Sets the base table name.
void	setBaseTableOwner(java.lang.String baseTableOwner) Sets the base table owner.
void	setCurrentSchema(java.lang.String currentSchema) Sets the current schema.
void	setDDLText(java.lang.String ddlText) Sets the DDL statement text.
void	setEditionName(java.lang.String editionName) Sets the edition name.
void	setLogonUser(java.lang.String logonUser) Sets the logon user name.
void	setObjectType(java.lang.String objectType) Sets the object type.

Methods inherited from interface oracle.streams.LCR

getAttribute, getCommandType, getObjectName, getObjectOwner, getPosition, getSourceDatabaseName, getSourceTime, getTag, getTransactionId, setAttribute, setCommandType, setObjectName, setObjectOwner, setPosition, setSourceDatabaseName, setSourceTime, setTag, setTransactionId

Method Detail

setCurrentSchema

void setCurrentSchema(java.lang.String currentSchema)

Sets the current schema.
The current schema is used if no schema is specified explicitly for the modified database objects in DDLText. If a schema is specified in DDLText that differs from the one specified for currentSchema, then the schema specified in DDLText is used.

Parameters:

currentSchema - A string contains the current schema. Ensure that this parameter is set to a non-null value.

setDDLText

void setDDLText(java.lang.String ddlText)

Sets the DDL statement text.

Parameters:

ddlText - The DDL statement. Set this parameter to a non-NULL value.

setLogonUser

void setLogonUser(java.lang.String logonUser)

Sets the logon user name.
The logon user is the user whose session executed the DDL statement.

Parameters:

logonUser - The logon user name

setBaseTableOwner

void setBaseTableOwner(java.lang.String baseTableOwner)

Sets the base table owner.
If the DDL statement is related to a table (such as CREATE TABLE and ALTER TABLE), or if the DDL statement involves a table (such as creating a trigger on a table), then baseTableOwner specifies the owner of the table. Otherwise, set baseTableOwner to NULL.

Parameters:

baseTableOwner - The base table owner

setBaseTableName

void setBaseTableName(java.lang.String baseTableName)

Sets the base table name.
If the DDL statement is related to a table (such as CREATE TABLE and ALTER TABLE), or if the DDL statement involves a table (such as creating a trigger on a table), then baseTableName specifies the name of the table. Otherwise, set baseTableName to NULL.

Parameters:

baseTableName - The base table name

setObjectType

void setObjectType(java.lang.String objectType)

Sets the object type.

Parameters:

objectType - The type of objec on which the DDL statement was executed. See Oracle Call Interface Programmer's Guide for more information.

setEditionName

void setEditionName(java.lang.String editionName)
             throws StreamsException

Sets the edition name.
The name of the edition in which the DDL statement was executed.

Parameters:

editionName - the edition name.

Throws:

StreamsException - if error occurs when obtaining edition name.

getCurrentSchema

java.lang.String getCurrentSchema()

Gets the current schema name.
The current schema is used if no schema is specified explicitly for the modified database objects in DDLText. If a schema is specified in DDLText that differs from the one specified for currentSchema, then the schema specified in DDLText is used.

Returns:

A string contains the current schema

getDDLText

java.lang.String getDDLText()

Gets the DDL statement text.

Returns:

A string contains the DDL statement

getLogonUser

java.lang.String getLogonUser()

Gets the logon user name.
The logon user is the user whose session executed the DDL statement.

Returns:

A string contains the logon user name

getBaseTableOwner

java.lang.String getBaseTableOwner()

Gets the base table owner.
If the DDL statement is related to a table (such as CREATE TABLE and ALTER TABLE), or if the DDL statement involves a table (such as creating a trigger on a table), then baseTableOowner specifies the owner of the table. Otherwise, NULL is returned.

Returns:

A string contains the base table owner

getBaseTableName

java.lang.String getBaseTableName()

Gets the base table name.
If the DDL statement is related to a table (such as CREATE TABLE and ALTER TABLE), or if the DDL statement involves a table (such as creating a trigger on a table), then baseTableName specifies the name of the table. Otherwise, NULL is returned.

Returns:

A string contains the base table name

getObjectType

java.lang.String getObjectType()

Gets the object type.
The type of object on which the DDL statement was executed. See Oracle Call Interface Programmer's Guide for more information.

Returns:

A string contains the object type

getEditionName

java.lang.String getEditionName()
                         throws StreamsException

Gets the edition name.
The name of the edition in which the DDL statement was executed.

Returns:

A string contains the edition name

Throws:

StreamsException - if error occurs when obtaining edition name.