Package mks.ci.server.engine

Class CopyTree.ScriptCopyTreeArgsBean

java.lang.Object

mks.frame.triggers.ScriptExposableBaseBean

mks.frame.triggers.beans.ScriptBaseBean

mks.ci.server.engine.LocalTriggerManager.ScriptIMBaseBean

mks.ci.server.engine.CopyTree.ScriptArgsBaseBean

mks.ci.server.engine.CopyTree.ScriptCopyTreeArgsBean

All Implemented Interfaces:

mks.frame.triggers.ScriptExposableBean

Enclosing class:

CopyTree

public static class CopyTree.ScriptCopyTreeArgsBean
extends CopyTree.ScriptArgsBaseBean
implements mks.frame.triggers.ScriptExposableBean

The Copy Tree Arguments Bean (imCopyTreeArgsBean).

This bean is available when the copytree trigger is fired.

The pre copytree trigger is fired before any part of the copytree operation starts, and simply provides the information supplied by the client.

The post copytree trigger is fired after the copytree operation has committed. At this point, it has completed. Both this bean, and the imCopyTreeResultBean CopyTree.ScriptCopyTreeResultBean are available.

Constructor Summary

Constructors

Constructor	Description
ScriptCopyTreeArgsBean(mks.ci.common.CopyTreeArgs args, java.util.Collection<java.lang.Integer> topLevelIssues, int userId, java.sql.Connection c)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getExposedName()	The name of this bean: imCopyTreeArgsBean
java.util.Collection<java.lang.Integer>	getTopLevelIssues()	List of all the top level issues being copied/branched.
java.lang.String[]	getTraversalFields(java.lang.String type)	Retrieve for a specific type the set of traversal fields.
boolean	isBranch()	Was the --branch flag specified?

Methods inherited from class mks.ci.server.engine.CopyTree.ScriptArgsBaseBean

asOfDate, getCopyFields, getPostFieldProject, isCopyAttachments

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

ScriptCopyTreeArgsBean

public ScriptCopyTreeArgsBean(mks.ci.common.CopyTreeArgs args,
                              java.util.Collection<java.lang.Integer> topLevelIssues,
                              int userId,
                              java.sql.Connection c)

Method Detail

getTopLevelIssues

public java.util.Collection<java.lang.Integer> getTopLevelIssues()

List of all the top level issues being copied/branched. This is not the full hierarchy, this is the set of top issues provided by the client.

isBranch

public boolean isBranch()

Was the --branch flag specified?

Returns:

true if specified

getTraversalFields

public java.lang.String[] getTraversalFields(java.lang.String type)
                                      throws mks.frame.triggers.TriggerException

Retrieve for a specific type the set of traversal fields.

Parameters:

type - the name of the type

Returns:

A string array of the fields which are to be traversed for the specified type.

A return value of null means that the type was not explicitly specified, and there was no generic all types list.

Throws:

mks.frame.triggers.TriggerException - if the type does not exist

getExposedName

public java.lang.String getExposedName()

The name of this bean: imCopyTreeArgsBean

Specified by:

getExposedName in interface mks.frame.triggers.ScriptExposableBean

Specified by:

getExposedName in class ScriptBaseBean

Returns:

the bean name: siMemberBean.