Interface ApprovalRule
-
- All Known Implementing Classes:
GroupApprovalRule,ParameterReferenceRule,UserApprovalRule
public interface ApprovalRule
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IntegerapprovalsCount()Return count of approvals required for this rule.Stringdescribe()Provide human-readable description of approval rule.StringdescribeShort()Provide short description that allows to distinguish this rule from othersAuthorityHoldergetAuthorityHolder()Retrieve authority holder which is used in the rule.BooleanisMet(Set<SUser> users)Return true if current set of users who have approved build fits this rule, or false otherwise.BooleanisUserAllowedToApprove(SUser user)Return true if specified user may apply to this rule, or false otherwise.Set<SUser>matchingUsers(Set<SUser> users)Return subset of users who have approved given build.
-
-
-
Method Detail
-
approvalsCount
Integer approvalsCount()
Return count of approvals required for this rule.
-
isMet
Boolean isMet(Set<SUser> users)
Return true if current set of users who have approved build fits this rule, or false otherwise.
-
matchingUsers
Set<SUser> matchingUsers(Set<SUser> users)
Return subset of users who have approved given build.
-
isUserAllowedToApprove
Boolean isUserAllowedToApprove(SUser user)
Return true if specified user may apply to this rule, or false otherwise.
-
getAuthorityHolder
AuthorityHolder getAuthorityHolder()
Retrieve authority holder which is used in the rule.
-
describe
String describe()
Provide human-readable description of approval rule.
-
describeShort
String describeShort()
Provide short description that allows to distinguish this rule from others- Returns:
-
-