org.jenkinsci.plugins.workinghours

Class WorkingHoursConfig

java.lang.Object

hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

jenkins.model.GlobalConfiguration

org.jenkinsci.plugins.workinghours.WorkingHoursConfig

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<jenkins.model.GlobalConfiguration>, hudson.model.Saveable, jenkins.util.io.OnMaster

@Extension(optional=true)
public class WorkingHoursConfig
extends jenkins.model.GlobalConfiguration

Provides configuration options for this plugin.

Author:

jeffpearce

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
WorkingHoursConfig() Default constructor - loads the configuration.

Method Summary

Modifier and Type	Method and Description
static WorkingHoursConfig	get() Convenience method to get the configuration object.
List<TimeRange>	getBuildTimeMatrix() Gets the list of included times.
String	getDisplayName() Gets human readable name.
List<ExcludedDate>	getExcludedDates() Gets the list of excluded dates.
String	getJobHoldText() Gets the message to be displayed when the job is blocked
void	setBuildTimeMatrix(List<TimeRange> value) Sets the list of included times.
void	setCustomJobHoldText(String customJobHoldText) Sets new string to display when jobs are blocked
void	setExcludedDates(List<ExcludedDate> value) Sets the list of excluded dates.

Methods inherited from class jenkins.model.GlobalConfiguration

all, configure, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkingHoursConfig

public WorkingHoursConfig()

Default constructor - loads the configuration.

Method Detail

get

public static WorkingHoursConfig get()

Convenience method to get the configuration object.

Returns:

the configuration object

getDisplayName

public final String getDisplayName()

Gets human readable name.

Overrides:

getDisplayName in class hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

Returns:

human readable name

getBuildTimeMatrix

public List<TimeRange> getBuildTimeMatrix()

Gets the list of included times.

Returns:

list of included times.

setBuildTimeMatrix

public void setBuildTimeMatrix(@CheckForNull
                               List<TimeRange> value)

Sets the list of included times.

Parameters:

value - the list of included times.

getExcludedDates

public List<ExcludedDate> getExcludedDates()

Gets the list of excluded dates.

Returns:

the list of excluded dates.

setExcludedDates

public void setExcludedDates(@CheckForNull
                             List<ExcludedDate> value)

Sets the list of excluded dates.

Parameters:

value - the list of excluded dates.

getJobHoldText

public String getJobHoldText()

Gets the message to be displayed when the job is blocked

Returns:

custom message or the default message, if the custom message is null.

setCustomJobHoldText

public void setCustomJobHoldText(String customJobHoldText)

Sets new string to display when jobs are blocked

Parameters:

customJobHoldText - string to use as the jobHeldDescription