RuleThenEnum

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

edu.internet2.middleware.grouper.rules
Enum RuleThenEnum

java.lang.Object
  java.lang.Enum<RuleThenEnum>
      edu.internet2.middleware.grouper.rules.RuleThenEnum

All Implemented Interfaces:: Serializable, Comparable<RuleThenEnum>

public enum RuleThenEnum
extends Enum<RuleThenEnum>
extends Enum<RuleThenEnum>

built in if condition

Author:: mchyzer

Enum Constant Summary
`addMemberToOwnerGroup` add the member (the current one being acted on) to the owner group
`assignAttributeDefPrivilegeToAttributeDefId` assign privilege(s) to subject on the attributeDef being acted on (attributeDefId)
`assignDisabledDaysToOwnerPermissionDefAssignments` assign a disabled date if there is a permission assignment to the owner attribute def
`assignGroupPrivilegeToGroupId` assign privilege(s) to subject on the group being acted on (groupId)
`assignMembershipDisabledDaysForOwnerGroupId` assign a disabled date if there is a membership in this group to the owner group ${ruleElUtils.assignMembershipDisabledDaysForGroupId(ownerGroupId, memberId, 7)}
`assignStemPrivilegeToStemId` assign privilege(s) to subject on the stem being acted on (stemId)
`reassignAttributeDefPrivilegesIfFromGroup`
`reassignGroupPrivilegesIfFromGroup`
`reassignStemPrivilegesIfFromGroup`
`removeMemberFromOwnerGroup` remove the member (the current one being acted on) from the owner group
`removeMemberFromOwnerPermissionDefAssignments` remove the member (the current one being acted on) from the roles and assignments associated with the owner attribute definition
`sendEmail` send an email about this action.
`veto` veto the operation (note, must be a transactional check for this to work)

Method Summary
`abstract Object`	`fireRule(RuleDefinition ruleDefinition, RuleEngine ruleEngine, RulesBean rulesBean, StringBuilder logDataForThisDefinition)` fire this rule
`String`	`validate(RuleDefinition ruleDefinition)` validate the rule
`static RuleThenEnum`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static RuleThenEnum`	`valueOfIgnoreCase(String string, boolean exceptionOnNull)` do a case-insensitive matching
`static RuleThenEnum[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
`compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

assignDisabledDaysToOwnerPermissionDefAssignments

public static final RuleThenEnum assignDisabledDaysToOwnerPermissionDefAssignments

assign a disabled date if there is a permission assignment to the owner attribute def

assignMembershipDisabledDaysForOwnerGroupId

public static final RuleThenEnum assignMembershipDisabledDaysForOwnerGroupId

assign a disabled date if there is a membership in this group to the owner group ${ruleElUtils.assignMembershipDisabledDaysForGroupId(ownerGroupId, memberId, 7)}

veto

public static final RuleThenEnum veto

veto the operation (note, must be a transactional check for this to work)

removeMemberFromOwnerPermissionDefAssignments

public static final RuleThenEnum removeMemberFromOwnerPermissionDefAssignments

remove the member (the current one being acted on) from the roles and assignments associated with the owner attribute definition

removeMemberFromOwnerGroup

public static final RuleThenEnum removeMemberFromOwnerGroup

remove the member (the current one being acted on) from the owner group

addMemberToOwnerGroup

public static final RuleThenEnum addMemberToOwnerGroup

add the member (the current one being acted on) to the owner group

reassignGroupPrivilegesIfFromGroup

public static final RuleThenEnum reassignGroupPrivilegesIfFromGroup

reassignAttributeDefPrivilegesIfFromGroup

public static final RuleThenEnum reassignAttributeDefPrivilegesIfFromGroup

reassignStemPrivilegesIfFromGroup

public static final RuleThenEnum reassignStemPrivilegesIfFromGroup

assignGroupPrivilegeToGroupId

public static final RuleThenEnum assignGroupPrivilegeToGroupId

assign privilege(s) to subject on the group being acted on (groupId)

assignStemPrivilegeToStemId

public static final RuleThenEnum assignStemPrivilegeToStemId

assign privilege(s) to subject on the stem being acted on (stemId)

assignAttributeDefPrivilegeToAttributeDefId

public static final RuleThenEnum assignAttributeDefPrivilegeToAttributeDefId

assign privilege(s) to subject on the attributeDef being acted on (attributeDefId)

sendEmail

public static final RuleThenEnum sendEmail

 send an email about this action.
 arg0: comma separated email addresses to send to.  ${subjectEmail} is a variable which evaluates to the email of the subject (if applicable)
 arg1: subject (some text/EL), or template: templateName 
 arg2: body (some text/EL), or template: templateName
 The template name comes from the directory in grouper.properties: rules.emailTemplatesFolder

Method Detail

values

public static RuleThenEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RuleThenEnum c : RuleThenEnum.values())
    System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they are declared

valueOf

public static RuleThenEnum valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:: name - the name of the enum constant to be returned.
Returns:: the enum constant with the specified name
Throws:: IllegalArgumentException - if this enum type has no constant with the specified name; NullPointerException - if the argument is null

valueOfIgnoreCase

public static RuleThenEnum valueOfIgnoreCase(String string,
                                             boolean exceptionOnNull)

do a case-insensitive matching

Parameters:: string -; exceptionOnNull - will not allow null or blank entries
Returns:: the enum or null or exception if not found

fireRule

public abstract Object fireRule(RuleDefinition ruleDefinition,
                                RuleEngine ruleEngine,
                                RulesBean rulesBean,
                                StringBuilder logDataForThisDefinition)

fire this rule

Parameters:: ruleDefinition -; ruleEngine -; rulesBean -; logDataForThisDefinition - is null if not logging, and non null if things should be appended
Returns:: something for log

validate

public String validate(RuleDefinition ruleDefinition)

validate the rule

Parameters:: ruleDefinition -
Returns:: the validation reason