oracle.sysman.dbTarget.db.changemgr.emo.cpapi
Class ChangeItemInfo

java.lang.Object
  extended by oracle.sysman.dbTarget.db.changemgr.emo.cpapi.ChangeItemInfo
Direct Known Subclasses:
ApplyChangeItemResult, ChangeItem

public class ChangeItemInfo
extends java.lang.Object

ChangeItemInfo contains top-level information that identifies and describes a change item. It does not contain the detailed information about the change to be carried out by the change item. A change item specifies an action to be taken for a single database object at one or more destination databases.


Field Summary
static java.lang.String CLUSTER
           
static int CP_ADD
          Specifies that the change item is to add the object to the destination database.
static int CP_DROP
          Specifies that the change item is to drop the object from the destination database.
static int CP_MODIFY
          Specifies that the change item is to modify the object in the destination database.
static int CP_MONITOR
          Designates a change item that monitors potential development activity for a database object.
static int CP_NO_ACTION
           
static java.lang.String DB_LINK
           
static java.lang.String FUNCTION
           
static java.lang.String INDEX
           
static java.lang.String MATERIALIZED_VIEW
           
static java.lang.String MATERIALIZED_VIEW_LOG
           
static int MAX_DESCRIPTION_LENGTH
          Specifies the maximum length of a change item description.
static java.lang.String PACKAGE
           
static java.lang.String PACKAGE_BODY
           
static java.lang.String PACKAGE_SPEC
           
static java.lang.String PROCEDURE
           
static java.lang.String PROFILE
           
static java.lang.String ROLE
           
static java.lang.String ROLLBACK_SEGMENT
           
static java.lang.String SEQUENCE
           
static java.lang.String SYNONYM
           
static java.lang.String TABLE
           
static java.lang.String TABLESPACE
           
static java.lang.String TRIGGER
           
static java.lang.String TYPE
           
static java.lang.String USER
           
static java.lang.String VIEW
           
 
Constructor Summary
ChangeItemInfo()
          Default constructor creates an unitialized ChangeItemInfo.
ChangeItemInfo(int itemAction, java.lang.String typeName, java.lang.String objectName, java.lang.String objectSchema, java.lang.String description)
          Creates a ChangeItemInfo for a database object.
 
Method Summary
 java.lang.String getClientSourceDatabase()
          Returns the client's name of the source database for this Change Item.
 java.lang.String getDescription()
          Returns the description for the change item
 java.lang.String getEntMgrSourceDatabase()
          Returns the Enterprise Manager name of the source database for this Change Item.
 java.lang.String getGlobalSourceDatabase()
          Returns the global name of the source database for this Change Item.
 int getItemAction()
          Returns the action for the change item.
 java.lang.String getItemDisplayName()
          Returns the display name for the change item, including the object type
 java.lang.String getObjectName()
          Returns the object name for the change item
 java.lang.String getObjectSchema()
          Returns the object schema for the change item (Nonschema objects specify this as null.)
 java.lang.String getObjectType()
          Returns the object type of the change item.
 int getObjectTypeCode()
          Returns the object type code of the change item.
 void setClientSourceDatabase(java.lang.String db)
          Sets the client's name of the source database for this Change Item.
 void setDescription(java.lang.String description)
          Sets the description for the change item
 void setEntMgrSourceDatabase(java.lang.String db)
          Sets the Enterprise Manager name of the source database for this Change Item.
 void setGlobalSourceDatabase(java.lang.String db)
          Sets the global name of the source database for this Change Item.
 void setItemAction(int action)
          Sets the action for the change item.
 void setObjectName(java.lang.String name)
          Sets the object name for the change item.
 void setObjectSchema(java.lang.String schema)
          Sets the object schema for the change item.
 void setObjectType(java.lang.String typeName)
          Sets the object type of the change item.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CP_NO_ACTION

public static final int CP_NO_ACTION
See Also:
Constant Field Values

CP_ADD

public static final int CP_ADD
Specifies that the change item is to add the object to the destination database.

See Also:
Constant Field Values

CP_MODIFY

public static final int CP_MODIFY
Specifies that the change item is to modify the object in the destination database.

See Also:
Constant Field Values

CP_DROP

public static final int CP_DROP
Specifies that the change item is to drop the object from the destination database.

See Also:
Constant Field Values

CP_MONITOR

public static final int CP_MONITOR
Designates a change item that monitors potential development activity for a database object.

See Also:
Constant Field Values

CLUSTER

public static java.lang.String CLUSTER

DB_LINK

public static java.lang.String DB_LINK

FUNCTION

public static java.lang.String FUNCTION

INDEX

public static java.lang.String INDEX

MATERIALIZED_VIEW

public static java.lang.String MATERIALIZED_VIEW

MATERIALIZED_VIEW_LOG

public static java.lang.String MATERIALIZED_VIEW_LOG

PACKAGE

public static java.lang.String PACKAGE

PACKAGE_SPEC

public static java.lang.String PACKAGE_SPEC

PACKAGE_BODY

public static java.lang.String PACKAGE_BODY

PROCEDURE

public static java.lang.String PROCEDURE

PROFILE

public static java.lang.String PROFILE

ROLE

public static java.lang.String ROLE

ROLLBACK_SEGMENT

public static java.lang.String ROLLBACK_SEGMENT

SEQUENCE

public static java.lang.String SEQUENCE

SYNONYM

public static java.lang.String SYNONYM

TABLE

public static java.lang.String TABLE

TABLESPACE

public static java.lang.String TABLESPACE

TRIGGER

public static java.lang.String TRIGGER

TYPE

public static java.lang.String TYPE

USER

public static java.lang.String USER

VIEW

public static java.lang.String VIEW

MAX_DESCRIPTION_LENGTH

public static final int MAX_DESCRIPTION_LENGTH
Specifies the maximum length of a change item description.

See Also:
Constant Field Values
Constructor Detail

ChangeItemInfo

public ChangeItemInfo()
Default constructor creates an unitialized ChangeItemInfo.


ChangeItemInfo

public ChangeItemInfo(int itemAction,
                      java.lang.String typeName,
                      java.lang.String objectName,
                      java.lang.String objectSchema,
                      java.lang.String description)
               throws ChangePlanAccessException
Creates a ChangeItemInfo for a database object.

Parameters:
itemAction - Change item's action. (See setItemAction)
typeName - The object type name, one of:
  • CLUSTER
  • DB_LINK
  • FUNCTION
  • INDEX
  • MATERIALIZED_VIEW
  • MATERIALIZED_VIEW_LOG
  • PACKAGE
  • PROCEDURE
  • SEQUENCE
  • SYNONYM
  • TABLE
  • TRIGGER
  • TYPE
  • VIEW
  • PROFILE
  • ROLE
  • TABLESPACE
  • USER
objectName - the object name
objectSchema - the object schema
description - description of the change item (limited to MAX_DESCRIPTION_LENGTH characters)
Throws:
ChangePlanAccessException - if the typeName does not specify one of the valid object types or itemAction is not a recognized action code.
Method Detail

setItemAction

public void setItemAction(int action)
Sets the action for the change item.

Parameters:
action - One of:
  • CP_ADD
  • CP_MODIFY
  • CP_DROP
  • CP_MONITOR

getItemAction

public int getItemAction()
Returns the action for the change item.

Returns:
One of:
  • CP_ADD
  • CP_MODIFY
  • CP_DROP
  • CP_MONITOR

setObjectType

public void setObjectType(java.lang.String typeName)
Sets the object type of the change item.

Parameters:
typeName - The object type name, one of:
  • CLUSTER
  • DB_LINK
  • FUNCTION
  • INDEX
  • MATERIALIZED_VIEW
  • MATERIALIZED_VIEW_LOG
  • PACKAGE
  • PROCEDURE
  • PROFILE
  • ROLE
  • SEQUENCE
  • SYNONYM
  • TABLE
  • TABLESPACE
  • TRIGGER
  • TYPE
  • USER
  • PROFILE
  • ROLE
  • TABLESPACE
  • USER
  • VIEW

getObjectType

public java.lang.String getObjectType()
Returns the object type of the change item.

Returns:
The object type name.
See Also:
setObjectType

getObjectTypeCode

public int getObjectTypeCode()
Returns the object type code of the change item.

Returns:
The object type code.

setObjectName

public void setObjectName(java.lang.String name)
Sets the object name for the change item.

Parameters:
name - the object name

getObjectName

public java.lang.String getObjectName()
Returns the object name for the change item

Returns:
the object name

setObjectSchema

public void setObjectSchema(java.lang.String schema)
Sets the object schema for the change item. (Nonschema objects specify this as null.)

Parameters:
schema - the object schema

getObjectSchema

public java.lang.String getObjectSchema()
Returns the object schema for the change item (Nonschema objects specify this as null.)

Returns:
the object schema

setDescription

public void setDescription(java.lang.String description)
                    throws ChangePlanAccessException
Sets the description for the change item

Parameters:
description - description of the change item (limited to MAX_DESCRIPTION_LENGTH characters)
Throws:
ChangePlanAccessException - if the description exceeds the maximum length

getDescription

public java.lang.String getDescription()
Returns the description for the change item

Returns:
change item description

getItemDisplayName

public java.lang.String getItemDisplayName()
Returns the display name for the change item, including the object type

Returns:
the object display name

setClientSourceDatabase

public void setClientSourceDatabase(java.lang.String db)
Sets the client's name of the source database for this Change Item.

Parameters:
db - the name of the database or connection that was the source of this Change Item, meaningful to the CPAPI client

getClientSourceDatabase

public java.lang.String getClientSourceDatabase()
Returns the client's name of the source database for this Change Item.

Returns:
the name of the database or connection that was the source of this Change Item, meaningful to the CPAPI client

setEntMgrSourceDatabase

public void setEntMgrSourceDatabase(java.lang.String db)
Sets the Enterprise Manager name of the source database for this Change Item.

Parameters:
db - the name of the database or connection that was the source of this Change Item, meaningful to Enterprise Manager

getEntMgrSourceDatabase

public java.lang.String getEntMgrSourceDatabase()
Returns the Enterprise Manager name of the source database for this Change Item.

Returns:
the name of the database or connection that was the source of this Change Item, meaningful to Enterprise Manager

setGlobalSourceDatabase

public void setGlobalSourceDatabase(java.lang.String db)
Sets the global name of the source database for this Change Item.

Parameters:
db - the global name of the database or connection that was the source of this Change Item

getGlobalSourceDatabase

public java.lang.String getGlobalSourceDatabase()
Returns the global name of the source database for this Change Item.

Returns:
the global name of the database or connection that was the source of this Change Item

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object