Interface ImmutableRequirement
-
- All Superinterfaces:
BambooIdProvider
- All Known Subinterfaces:
Requirement
,RequirementDetails
- All Known Implementing Classes:
AgentAssignmentRequirement
,RequirementDetailsImpl
,RequirementImpl
public interface ImmutableRequirement extends BambooIdProvider
Read only view of a requirement- Since:
- v5.6
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ImmutableRequirement.MatchType
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotNull String
getKey()
Represents the requirement.@Nullable String
getMatchValue()
A match requirement value.long
getOwnerId()
The identifier of thisRequirement
that is used to identify it uniquely for allRequirement
s created bygetPluginModuleKey()
@Nullable String
getPluginModuleKey()
TheModuleDescriptor.getKey()
that is responsible for the Lifecycle of thisRequirement
@NotNull ImmutableRequirement.MatchType
getTypeOfMatch()
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.-
Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider
getId
-
-
-
-
Method Detail
-
getKey
@NotNull @NotNull String getKey()
Represents the requirement. Must match exactly to theCapability
getKey().- Returns:
-
getMatchValue
@Nullable @Nullable String getMatchValue()
A match requirement value. Even "EXISTS" matches are represented as a regex match with match value ".*"The regex must match the
Capability
value.- Returns:
- the value to match.
-
getTypeOfMatch
@NotNull @NotNull ImmutableRequirement.MatchType getTypeOfMatch()
- Returns:
- representing the type of match
-
isReadonly
Boolean isReadonly()
If a requirement is readonly, it cannot be removed through the UI (the backend can do what it wants, however)- Returns:
- true if the requirement cannot be removed or edited via the UI.
-
getOwnerId
long getOwnerId()
The identifier of thisRequirement
that is used to identify it uniquely for allRequirement
s created bygetPluginModuleKey()
- Returns:
- ownerId
-
getPluginModuleKey
@Nullable @Nullable String getPluginModuleKey()
TheModuleDescriptor.getKey()
that is responsible for the Lifecycle of thisRequirement
- Returns:
- pluginKey
-
isRegexMatch
boolean isRegexMatch()
Is this a regex match requirement or exact match requirement.- Returns:
-
-