com.atlassian.bamboo.v2.build.agent.capability
Interface Requirement

All Superinterfaces:

BambooIdProvider, BambooObject

All Known Implementing Classes:

AgentAssignmentRequirement, RequirementImpl

public interface Requirement
extends BambooObject

Field Summary

static java.lang.String	EQUALS
static java.lang.String	EXISTS
static java.lang.String	REGEX

Method Summary

boolean	belongsToPlugin()
java.lang.String	getKey() Represents the requirement.
java.lang.String	getMatchType()
java.lang.String	getMatchValue() A match requirement value.
long	getOwnerId() The identifier of this Requirement that is used to identify it uniquely for all Requirements created by getPluginModuleKey()
java.lang.String	getPluginModuleKey() The ModuleDescriptor.getKey() that is responsible for the Lifecycle of this Requirement
RequirementSet	getRequirementSet()
java.lang.Boolean	isReadonly() If a requirement is readonly, it cannot be removed through the UI (the backend can do what it wants, however)
boolean	isRegexMatch() Is this a regex match requirement or exact match requirement.
boolean	isSystemRequirement() Is this a system requirement? System requirements are builder/jdk requirements which cannot be removed from the plan.
void	setKey(java.lang.String key)
void	setOwnerId(long uniqueIdentifier)
void	setPluginModuleKey(java.lang.String pluginModuleKey)
void	setReadonly(java.lang.Boolean readonly)
void	setRequirementSet(RequirementSet requirementSet)

Methods inherited from interface com.atlassian.bamboo.core.BambooObject

setId

Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider

getId

Field Detail

EXISTS

static final java.lang.String EXISTS

See Also:

Constant Field Values

EQUALS

static final java.lang.String EQUALS

See Also:

Constant Field Values

REGEX

static final java.lang.String REGEX

See Also:

Constant Field Values

Method Detail

getKey

@NotNull
java.lang.String getKey()

Represents the requirement. Must match exactly to the Capability getKey().

Returns:

setKey

void setKey(java.lang.String key)

getMatchValue

@Nullable
java.lang.String getMatchValue()

A match requirement value. The regex must match the Capability value.

Returns:

isRegexMatch

boolean isRegexMatch()

Is this a regex match requirement or exact match requirement.

Returns:

isSystemRequirement

boolean isSystemRequirement()

Is this a system requirement? System requirements are builder/jdk requirements which cannot be removed from the plan.

Returns:

isReadonly

java.lang.Boolean isReadonly()

If a requirement is readonly, it cannot be removed through the UI (the backend can do what it wants, however)

Returns:

setReadonly

void setReadonly(java.lang.Boolean readonly)

getPluginModuleKey

@Nullable
java.lang.String getPluginModuleKey()

The ModuleDescriptor.getKey() that is responsible for the Lifecycle of this Requirement

Returns:

pluginKey

setPluginModuleKey

void setPluginModuleKey(java.lang.String pluginModuleKey)

getOwnerId

long getOwnerId()

The identifier of this Requirement that is used to identify it uniquely for all Requirements created by getPluginModuleKey()

Returns:

ownerId

setOwnerId

void setOwnerId(long uniqueIdentifier)

belongsToPlugin

boolean belongsToPlugin()

Returns:

true if this Requirement belongs to a plugin

getRequirementSet

@Nullable
RequirementSet getRequirementSet()

Returns:

requirementSet that this Requirement is linked to

setRequirementSet

void setRequirementSet(RequirementSet requirementSet)

getMatchType

java.lang.String getMatchType()