|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectoracle.sysman.dbTarget.db.changemgr.emo.cpapi.ChangePlanInfo
oracle.sysman.dbTarget.db.changemgr.emo.cpapi.ChangePlan
public class ChangePlan
ChangePlan provides methods that allow a client to access and manipulate a single Change Manager Change Plan. To use this class:
ChangePlanAccess.getOneChangePlan
).
getChangeItems
).
getOneChangeItem
). The
ChangeItem object specifies an action to carry out at the
destination database (Add, Modify, or Drop) and includes
an XML document that contains the definition of the object
or modifications to the object. To modify a change item,
get the corresponding ChangeItem object, carry out the modfications
on it, and use updateChangeItem
to write the changes back to the Change Plan in the
repository.
addChangeItem
).
updateChangeItem
). Use this
call to change the object definition or modifications specified
in the change item.
removeChangeItem
).
userActionAllowed
). This call is
provided to allow UI implementors to enable or disable various
user actions.
Method Summary | |
---|---|
void |
addChangeItem(ChangeItem item)
Adds a change item to the Change Plan. |
ChangeItemInfo[] |
getChangeItems()
Gets a list of change items contained in the Change Plan. |
ChangeItem |
getOneChangeItem(ChangeItemInfo itemInfo)
Gets the contents of a single change item from the Change Plan. |
java.lang.String |
getPostScript()
Returns the script that executes at the destination database after the script that is generated to carry out the the actions of the change items. |
java.lang.String |
getPreScript()
Returns the script that executes at the destination database before the script that is generated to carry out the the actions of the change items. |
void |
removeChangeItem(ChangeItemInfo itemInfo)
Removes a change item from the Change Plan. |
void |
setPostScript(java.lang.String script)
Establishes a script that is executed at the destination database after the script that is generated to carry out the the actions of the change items. |
void |
setPreScript(java.lang.String script)
Establishes a script that is executed at the destination database before the script that is generated to carry out the the actions of the change items. |
java.lang.String |
toString()
|
void |
updateChangeItem(ChangeItem item)
Updates the content of an existing change item in the Change Plan. |
int |
userActionAllowed(int userAction)
Indicates whether a specified action can be performed by the logged-in user on this Change Plan. |
Methods inherited from class oracle.sysman.dbTarget.db.changemgr.emo.cpapi.ChangePlanInfo |
---|
getPlanDescription, getPlanName, getPlanOwner, setPlanDescription, setPlanName, setPlanOwner |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public ChangeItemInfo[] getChangeItems() throws ChangePlanAccessException, java.sql.SQLException
java.sql.SQLException
- if an unexpected SQLException occurs
ChangePlanAccessException
public ChangeItem getOneChangeItem(ChangeItemInfo itemInfo) throws ChangePlanAccessException, java.sql.SQLException
itemInfo
- a ChangeItemInfo object identifying the
change item to be retrieved.
ChangePlanAccessException
- if the specified change item does
not exist, or if the logged-in user does
not have permission to view the
specified change item.
java.sql.SQLException
- if an unexpected SQLException occurspublic void addChangeItem(ChangeItem item) throws ChangePlanAccessException, java.sql.SQLException
item
- a ChangeItem object containing
all the information needed to initialize
a change item of the specified action
type.
ChangePlanAccessException
- if the specified change item already
exists, if arguments required to
create change items of the specified
action type are omitted, or if the
logged-in user does
not have permission to add the
specified change item.
java.sql.SQLException
- if an unexpected SQLException occurspublic void updateChangeItem(ChangeItem item) throws ChangePlanAccessException, java.sql.SQLException
NOTE: The current design of this package assumes that XML comparison and change conflict detection take place in the client-side code, that is, when the ChangeItem is created or updated. If this is not the case, comparison and conflict detection will take place in the CM mid-tier code running in the EM server. In that case, this method will need to return a list of conflicts detected (if any) and the update operation will fail if any conflicts are detected.
item
- a ChangeItem object containing the
updated change item information'
ChangePlanAccessException
- if the specified change item does not
exist, if arguments required to
update change items of the specified
action type are omitted, or if the
logged-in user does
not have permission to update the
specified change item.
java.sql.SQLException
- if an unexpected SQLException occurspublic void removeChangeItem(ChangeItemInfo itemInfo) throws ChangePlanAccessException, java.sql.SQLException
itemInfo
- a ChangeItemInfo object identifying the
change item to be removed.
ChangePlanAccessException
- if the specified change item does not
exist, or if the logged-in user does
not have permission to remove the
specified change item.
java.sql.SQLException
- if an unexpected SQLException occurspublic int userActionAllowed(int userAction) throws ChangePlanAccessException, java.sql.SQLException
userAction
- Specifies the desired action:
ChangePlanAccessException
java.sql.SQLException
public void setPreScript(java.lang.String script) throws java.sql.SQLException
script
- the script to be executed.
ChangePlanAccessException
- if the logged-in user does
not have permission to add the script.
java.sql.SQLException
- if an unexpected SQLException occurs.public java.lang.String getPreScript() throws java.sql.SQLException
java.sql.SQLException
- if an unexpected SQLException occurs.public void setPostScript(java.lang.String script) throws java.sql.SQLException
script
- the script to be executed.
ChangePlanAccessException
- if the logged-in user does
not have permission to add the script.
java.sql.SQLException
- if an unexpected SQLException occurs.public java.lang.String getPostScript() throws java.sql.SQLException
java.sql.SQLException
- if an unexpected SQLException occurs.public java.lang.String toString()
toString
in class ChangePlanInfo
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |