Package mks.ci.server.engine

Class EngineLabel.ScriptLabelArgsBean

java.lang.Object

mks.frame.triggers.ScriptExposableBaseBean

mks.frame.triggers.beans.ScriptBaseBean

mks.ci.server.engine.LocalTriggerManager.ScriptIMBaseBean

mks.ci.server.engine.EngineLabel.ScriptLabelArgsBean

All Implemented Interfaces:

mks.frame.triggers.ScriptExposableBean

Enclosing class:

EngineLabel

public static class EngineLabel.ScriptLabelArgsBean
extends LocalTriggerManager.ScriptIMBaseBean
implements mks.frame.triggers.ScriptExposableBean

This bean is made available when a Label trigger is fired. It is available during both Pre and Post Label triggers.

Constructor Summary

Constructors

Constructor	Description
ScriptLabelArgsBean(mks.ci.common.ManipulateLabelArgs args, int issueID, int userId, java.sql.Connection c)

Method Summary

Modifier and Type	Method	Description
java.util.Date	getAsOfDate()	For an add or move label operation, this is the time the label should be placed at.
java.lang.String	getExposedName()	The name of this bean: imLabelArgsBean
int	getIssueID()	Get the issue id against which the label is being applied.
java.lang.String	getLabel()	Return the label name being operated on.
boolean	isAddLabel()	Is this an issue add, without the movelabel option?
boolean	isDeleteLabel()	Is this an issue delete?
boolean	isMoveLabel()	Is this an issue add, with the movelabel option?

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

ScriptLabelArgsBean

public ScriptLabelArgsBean(mks.ci.common.ManipulateLabelArgs args,
                           int issueID,
                           int userId,
                           java.sql.Connection c)

Method Detail

getAsOfDate

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

For an add or move label operation, this is the time the label should be placed at.

Returns:

a Date object. If an as of time or label was not specified on the operation, null is returned.

Throws:

mks.frame.triggers.TriggerException - if the operation being performed is a delete label.

getIssueID

public int getIssueID()

Get the issue id against which the label is being applied.

isAddLabel

public boolean isAddLabel()

Is this an issue add, without the movelabel option?

isMoveLabel

public boolean isMoveLabel()

Is this an issue add, with the movelabel option?

isDeleteLabel

public boolean isDeleteLabel()

Is this an issue delete?

getLabel

public java.lang.String getLabel()

Return the label name being operated on.

getExposedName

public java.lang.String getExposedName()

The name of this bean: imLabelArgsBean

Specified by:

getExposedName in interface mks.frame.triggers.ScriptExposableBean

Specified by:

getExposedName in class ScriptBaseBean

Returns:

the bean name: siMemberBean.