Package mks.ci.server.engine

Class CopyTree.ScriptArgsBaseBean

java.lang.Object

mks.frame.triggers.ScriptExposableBaseBean

mks.frame.triggers.beans.ScriptBaseBean

mks.ci.server.engine.LocalTriggerManager.ScriptIMBaseBean

mks.ci.server.engine.CopyTree.ScriptArgsBaseBean

All Implemented Interfaces:

mks.frame.triggers.ScriptExposableBean

Direct Known Subclasses:

CopyTree.ScriptBranchArgsBean, CopyTree.ScriptCopyTreeArgsBean

Enclosing class:

CopyTree

public abstract static class CopyTree.ScriptArgsBaseBean
extends LocalTriggerManager.ScriptIMBaseBean
implements mks.frame.triggers.ScriptExposableBean

The base bean methods for both copytree and branch triggers.

Constructor Summary

Constructors

Constructor	Description
ScriptArgsBaseBean(mks.ci.common.CopyTreeArgs args, int userId, java.sql.Connection c)

Method Summary

Modifier and Type	Method	Description
java.util.Date	asOfDate()	The value of the --asOfDate option.
java.lang.String[]	getCopyFields(java.lang.String type)	Retrieve for a specific type the set of fields to copy
java.lang.String	getPostFieldProject(java.lang.String type)	Deprecated. This method is for internal use only and is intended to be replaced with a more generic method in the future.
boolean	isCopyAttachments()	Was the --copyAttachments flag specified?

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, getExposedName, 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, getExposedName, setEnvironmentBean

Constructor Detail

ScriptArgsBaseBean

public ScriptArgsBaseBean(mks.ci.common.CopyTreeArgs args,
                          int userId,
                          java.sql.Connection c)

Method Detail

isCopyAttachments

public boolean isCopyAttachments()

Was the --copyAttachments flag specified?

Returns:

true if specified

asOfDate

public java.util.Date asOfDate()

The value of the --asOfDate option. The as of date is used to branch or copy from an issue at a point in its past.

Returns:

a Date object if it was specified, or null.

getCopyFields

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

Retrieve for a specific type the set of fields to copy

Parameters:

type - the name of the type

Returns:

A string array of the fields which are to be copied 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.

An empty array indicates a request to copy all fields visible in the type.

Throws:

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

getPostFieldProject

@Deprecated
public java.lang.String getPostFieldProject(java.lang.String type)
                                     throws mks.frame.triggers.TriggerException

Deprecated.

This method is for internal use only and is intended to be replaced with a more generic method in the future.

Retrieve for a specific type any post field setting value for the project field.

Returns:

The project, as a string. null is returned if

1. No post field were specified
2. Post fields were specified, but the project field was not one of them.
3. The project field was specified as a post field, but with the empty value.

Throws:

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