Package mks.ci.server.engine

Class LocalTriggerManager.ScriptChangePackageBean

java.lang.Object

mks.frame.triggers.ScriptExposableBaseBean

mks.frame.triggers.beans.ScriptBaseBean

mks.ci.server.engine.LocalTriggerManager.ScriptIMBaseBean

mks.ci.server.engine.LocalTriggerManager.ScriptCPHasAttributesBean

mks.ci.server.engine.LocalTriggerManager.ScriptGenericChangePackageBean

mks.ci.server.engine.LocalTriggerManager.ScriptChangePackageBean

All Implemented Interfaces:

mks.frame.triggers.ScriptExposableBean

Enclosing class:

LocalTriggerManager

public static class LocalTriggerManager.ScriptChangePackageBean
extends LocalTriggerManager.ScriptGenericChangePackageBean

The Change Package Bean. This bean may be obtained from the issue bean, via the getChangePackageBeans call.

Constructor Summary

Constructors

Constructor	Description
ScriptChangePackageBean(int userId, mks.ci.cp.api.IChangePackage cp, java.sql.Connection c)

Method Summary

Modifier and Type	Method	Description
java.util.Date	getClosedTime()	Returns the date at which this change package was closed, as a Date object.
java.util.Date	getCreationTime()	Returns the date at which this change package was created, as a Date object.
java.lang.String	getDeployRequestState()	Get the state of the associated deploy request if one exists.
java.lang.String	getDeployTarget()	Return the name of the deploy target which this change package is associated with.
java.lang.String	getDescription()	Return the description of the change package.
LocalTriggerManager.ScriptChangePackageEntryBean[]	getEntryBeans()	Returns an array of Beans, each of which are imChangePackageEntryBeans, one for each change package entry that is part of the change package.
java.lang.String	getExposedName()	Returns the name of this bean that is exposed to the scripting language.
java.util.Set<java.lang.String>	getPropagated()	Returns the set of change package IDs, which this change package was used to propagate.
java.util.Set<java.lang.String>	getPropagatedBy()	Returns the set of change package IDs which were used to propagate this change package.
java.util.Set<java.lang.String>	getReverted()	Returns the set of change package IDs, which this change package was used to revert.
java.util.Set<java.lang.String>	getRevertedBy()	Returns the set of change package IDs which were used to revert this change package.
java.lang.String	getServer()	Return the server and port of the Source Code Management server which created this change package.
java.lang.String	getStage()	Return the name of the stage which this change package is associated with.
java.lang.String	getStagingSystem()	Return the name of the staging system which this change package is associated with.
java.lang.String	getUser()	Return the name of the user that created this change package.
boolean	isAccepted()	Returns true if the change package currently has an accepted status.
boolean	isClosed()	Returns true if the change package currently has a closed status.
boolean	isCommitFailed()	Returns true if the change package currently has a commit failed status.
boolean	isDeploy()	Returns true if the change package is a deploy change package.
boolean	isDevelopment()	Returns true if the change package is a development change package.
boolean	isDiscarded()	Returns true if the change package currently has a discarded status.
boolean	isOpen()	Returns true if the change package currently has an open status.
boolean	isPropagation()	Returns true if the change package is a propagation change package.
boolean	isRejected()	Returns true if the change package currently has a rejected status.
boolean	isResolution()	Returns true if the change package is a resolution change package.
boolean	isStaging()	Returns true if the change package is a staging change package.
boolean	isSubmitted()	Returns true if the change package currently has a submitted status.

Methods inherited from class mks.ci.server.engine.LocalTriggerManager.ScriptGenericChangePackageBean

getCreatedDate, getCreatedUser, getGenericEntryBeans, getID, getStatus, getSummary, getType, isImplementerChangePackage, isSIChangePackage

Methods inherited from class mks.ci.server.engine.LocalTriggerManager.ScriptCPHasAttributesBean

getAttributeDisplayValue, getAttributeValue

Methods inherited from class mks.ci.server.engine.LocalTriggerManager.ScriptIMBaseBean

getCurrentDatabaseTime, getCurrentDatabaseTime, getCurrentUser, getServerBean, getUserID, isParallelProcessingEnabled

Methods inherited from class mks.frame.triggers.beans.ScriptBaseBean

getEnvironmentBean, setEnvironmentBean

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface mks.frame.triggers.ScriptExposableBean

getEnvironmentBean, setEnvironmentBean

Constructor Detail

ScriptChangePackageBean

public ScriptChangePackageBean(int userId,
                               mks.ci.cp.api.IChangePackage cp,
                               java.sql.Connection c)

Method Detail

getDescription

public java.lang.String getDescription()
                                throws mks.frame.triggers.TriggerException

Return the description of the change package.

Throws:

mks.frame.triggers.TriggerException

getUser

public java.lang.String getUser()
                         throws mks.frame.triggers.TriggerException

Return the name of the user that created this change package. Only that user is permitted to close the change package or to create entries under it.

Throws:

mks.frame.triggers.TriggerException

isClosed

public boolean isClosed()
                 throws mks.frame.triggers.TriggerException

Returns true if the change package currently has a closed status.

Throws:

mks.frame.triggers.TriggerException

isOpen

public boolean isOpen()
               throws mks.frame.triggers.TriggerException

Returns true if the change package currently has an open status.

Throws:

mks.frame.triggers.TriggerException

isSubmitted

public boolean isSubmitted()
                    throws mks.frame.triggers.TriggerException

Returns true if the change package currently has a submitted status.

Throws:

mks.frame.triggers.TriggerException

isAccepted

public boolean isAccepted()
                   throws mks.frame.triggers.TriggerException

Returns true if the change package currently has an accepted status.

Throws:

mks.frame.triggers.TriggerException

isRejected

public boolean isRejected()
                   throws mks.frame.triggers.TriggerException

Returns true if the change package currently has a rejected status.

Throws:

mks.frame.triggers.TriggerException

isDiscarded

public boolean isDiscarded()
                    throws mks.frame.triggers.TriggerException

Returns true if the change package currently has a discarded status.

Throws:

mks.frame.triggers.TriggerException

isCommitFailed

public boolean isCommitFailed()
                       throws mks.frame.triggers.TriggerException

Returns true if the change package currently has a commit failed status.

Throws:

mks.frame.triggers.TriggerException

isResolution

public boolean isResolution()
                     throws mks.frame.triggers.TriggerException

Returns true if the change package is a resolution change package.

Throws:

mks.frame.triggers.TriggerException

isDevelopment

public boolean isDevelopment()
                      throws mks.frame.triggers.TriggerException

Returns true if the change package is a development change package.

Throws:

mks.frame.triggers.TriggerException

Since:

Integrity Solution 2006

isPropagation

public boolean isPropagation()
                      throws mks.frame.triggers.TriggerException

Returns true if the change package is a propagation change package.

Throws:

mks.frame.triggers.TriggerException

Since:

Integrity Solution 2006

isStaging

public boolean isStaging()
                  throws mks.frame.triggers.TriggerException

Returns true if the change package is a staging change package.

Throws:

mks.frame.triggers.TriggerException

Since:

Integrity Solution 2006

isDeploy

public boolean isDeploy()
                 throws mks.frame.triggers.TriggerException

Returns true if the change package is a deploy change package.

Throws:

mks.frame.triggers.TriggerException

Since:

Integrity Solution 2006

getClosedTime

public java.util.Date getClosedTime()
                             throws mks.frame.triggers.TriggerException

Returns the date at which this change package was closed, as a Date object. If the change package is not closed, then null is returned.

Throws:

mks.frame.triggers.TriggerException

getCreationTime

public java.util.Date getCreationTime()
                               throws mks.frame.triggers.TriggerException

Returns the date at which this change package was created, as a Date object.

Throws:

mks.frame.triggers.TriggerException

getServer

public java.lang.String getServer()
                           throws mks.frame.triggers.TriggerException

Return the server and port of the Source Code Management server which created this change package.

Returns:

The server and port of the Source Code Management server which created this change package. For historical change packages this may be the empty string.

Throws:

mks.frame.triggers.TriggerException

getStagingSystem

public java.lang.String getStagingSystem()
                                  throws mks.frame.triggers.TriggerException

Return the name of the staging system which this change package is associated with.

Returns:

The name of the staging system which this change package is associated with, null if this is not a staging or deploy change package.

Throws:

mks.frame.triggers.TriggerException

Since:

Integrity Solution 2006

getStage

public java.lang.String getStage()
                          throws mks.frame.triggers.TriggerException

Return the name of the stage which this change package is associated with.

Returns:

The name of the stage which this change package is associated with, null if this is not a staging or deploy change package.

Throws:

mks.frame.triggers.TriggerException

Since:

Integrity Solution 2006

getDeployTarget

public java.lang.String getDeployTarget()
                                 throws mks.frame.triggers.TriggerException

Return the name of the deploy target which this change package is associated with.

Returns:

The name of the deploy target which this change package is associated with, null if this is not a deploy change package.

Throws:

mks.frame.triggers.TriggerException

Since:

Integrity Solution 2006

getPropagated

public java.util.Set<java.lang.String> getPropagated()
                                              throws mks.frame.triggers.TriggerException

Returns the set of change package IDs, which this change package was used to propagate.

Returns:

The set of change package IDs which this change package was used to propagate.

Throws:

mks.frame.triggers.TriggerException

Since:

Integrity Solution 2006

getPropagatedBy

public java.util.Set<java.lang.String> getPropagatedBy()
                                                throws mks.frame.triggers.TriggerException

Returns the set of change package IDs which were used to propagate this change package.

Returns:

The set of change package IDs which were used to propagate this change package.

Throws:

mks.frame.triggers.TriggerException

Since:

Integrity Solution 2006

getReverted

public java.util.Set<java.lang.String> getReverted()
                                            throws mks.frame.triggers.TriggerException

Returns the set of change package IDs, which this change package was used to revert.

Returns:

The set of change package IDs which this change package was used to revert.

Throws:

mks.frame.triggers.TriggerException

Since:

Integrity 10.8

getRevertedBy

public java.util.Set<java.lang.String> getRevertedBy()
                                              throws mks.frame.triggers.TriggerException

Returns the set of change package IDs which were used to revert this change package.

Returns:

The set of change package IDs which were used to revert this change package.

Throws:

mks.frame.triggers.TriggerException

Since:

Integrity 10.8

getDeployRequestState

public java.lang.String getDeployRequestState()
                                       throws mks.frame.triggers.TriggerException

Get the state of the associated deploy request if one exists.

Returns:

The state of the deploy request.

Throws:

mks.frame.triggers.TriggerException

Since:

Integrity Solution 2006

getEntryBeans

public LocalTriggerManager.ScriptChangePackageEntryBean[] getEntryBeans()
                                                                 throws mks.frame.triggers.TriggerException

Returns an array of Beans, each of which are imChangePackageEntryBeans, one for each change package entry that is part of the change package.

Throws:

mks.frame.triggers.TriggerException

getExposedName

public java.lang.String getExposedName()

Returns the name of this bean that is exposed to the scripting language.

Specified by:

getExposedName in interface mks.frame.triggers.ScriptExposableBean

Overrides:

getExposedName in class LocalTriggerManager.ScriptGenericChangePackageBean

Returns:

the bean name: imChangePackageBean.