Package mks.ci.server.engine

Class LocalTriggerManager.ScriptGenericChangePackageBean

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

All Implemented Interfaces:

mks.frame.triggers.ScriptExposableBean

Direct Known Subclasses:

LocalTriggerManager.ScriptChangePackageBean

Enclosing class:

LocalTriggerManager

public static class LocalTriggerManager.ScriptGenericChangePackageBean
extends LocalTriggerManager.ScriptCPHasAttributesBean
implements mks.frame.triggers.ScriptExposableBean

The generic change package bean. This bean may be obtained from the issue bean via the .getAllChangePackages(), .getChangePackageBeans(String) and .getChangePackageBeans(List) calls.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.util.Date	getCreatedDate()	Returns the date that this change package was created.
java.lang.String	getCreatedUser()	Returns the name of the user that created the change package.
java.lang.String	getExposedName()	Returns the name of this this bean that is exposed to the scripting language.
LocalTriggerManager.ScriptGenericChangePackageEntryBean[]	getGenericEntryBeans()	Return the array of imGenericChangePackageEntryBean objects for this change package.
java.lang.String	getID()	Returns the id of the change package, in the form issue:relativecp e.g. 4:10 means issue 4, change package 10.
java.lang.String	getStatus()	Return the current status of the change package.
java.lang.String	getSummary()	Returns the change package summary.
LocalTriggerManager.ScriptChangePackageTypeBean	getType()	Returns the change package type.
boolean	isImplementerChangePackage()	Returns whether or not this is an Implementer change package.
boolean	isSIChangePackage()	Returns whether or not this is an SI change package.

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

ScriptGenericChangePackageBean

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

Method Detail

isSIChangePackage

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

Returns whether or not this is an SI change package.

Returns:

true if this is an SI change package, false otherwise.

Throws:

mks.frame.triggers.TriggerException

isImplementerChangePackage

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

Returns whether or not this is an Implementer change package.

Returns:

true if this is an Implementer change package, false otherwise.

Throws:

mks.frame.triggers.TriggerException

getID

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

Returns the id of the change package, in the form issue:relativecp e.g. 4:10 means issue 4, change package 10.

Returns:

a String representing the change package ID.

Throws:

mks.frame.triggers.TriggerException

getSummary

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

Returns the change package summary.

Returns:

a String containing the change package summary.

Throws:

mks.frame.triggers.TriggerException

getType

public LocalTriggerManager.ScriptChangePackageTypeBean getType()
                                                        throws mks.frame.triggers.TriggerException

Returns the change package type.

Returns:

an imChangePackageTypeBean corresponding to the change package type.

Throws:

mks.frame.triggers.TriggerException

getCreatedUser

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

Returns the name of the user that created the change package.

Returns:

a String representing the name of the user that created the change package.

Throws:

mks.frame.triggers.TriggerException

getCreatedDate

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

Returns the date that this change package was created.

Returns:

a Date object containing the date this change package was created.

Throws:

mks.frame.triggers.TriggerException

getStatus

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

Return the current status of the change package.

Returns:

a String containing the current status of the change package.

Throws:

mks.frame.triggers.TriggerException

getGenericEntryBeans

public LocalTriggerManager.ScriptGenericChangePackageEntryBean[] getGenericEntryBeans()
                                                                               throws mks.frame.triggers.TriggerException

Return the array of imGenericChangePackageEntryBean objects for this change package.

Returns:

the array of imGenericChangePackageEntryBean objects for the change package entries.

Throws:

mks.frame.triggers.TriggerException

getExposedName

public java.lang.String getExposedName()

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

Specified by:

getExposedName in interface mks.frame.triggers.ScriptExposableBean

Specified by:

getExposedName in class ScriptBaseBean

Returns:

the bean name: imGenericChangePackageBean.