org.kuali.rice.kew.rule
Class RuleBaseValues

java.lang.Object
  extended by org.kuali.rice.krad.bo.BusinessObjectBase
      extended by org.kuali.rice.krad.bo.PersistableBusinessObjectBase
          extended by org.kuali.rice.kew.rule.RuleBaseValues
All Implemented Interfaces:
Serializable, org.apache.ojb.broker.PersistenceBrokerAware, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, RuleContract, BusinessObject, PersistableBusinessObject
Direct Known Subclasses:
WebRuleBaseValues

@Entity
public class RuleBaseValues
extends PersistableBusinessObjectBase
implements RuleContract

A model bean for a Rule within the KEW rules engine.

Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase
extension, versionNumber
 
Constructor Summary
RuleBaseValues()
           
 
Method Summary
 void addRuleResponsibility(RuleResponsibilityBo ruleResponsibility)
           
 void addRuleResponsibility(RuleResponsibilityBo ruleResponsibility, Integer counter)
           
 RuleResponsibilityBo findResponsibility(String roleName)
           
 Timestamp getActivationDate()
           
 String getActiveIndDisplay()
           
 Boolean getCurrentInd()
           
 Timestamp getDeactivationDate()
           
 Boolean getDelegateRule()
           
 String getDescription()
          The description of the rule.
 String getDestinationUrl()
           
 String getDocTypeName()
          The documentTypeName of the rule.
 String getDocumentId()
           
 DocumentType getDocumentType()
           
 Map<String,String> getFieldValues()
           
 org.joda.time.DateTime getFromDate()
          The ending date of the rule.
 String getFromDateString()
           
 Timestamp getFromDateValue()
           
 org.kuali.rice.kim.impl.group.GroupBo getGroupBo()
           
 List<GroupRuleResponsibility> getGroupResponsibilities()
           
 String getGroupReviewerName()
           
 String getGroupReviewerNamespace()
           
 String getId()
          The unique identifier for an object.
 MyColumns getMyColumns()
           
 String getName()
          Get the rule name
 PersonImpl getPersonImpl()
           
 List<PersonRuleResponsibility> getPersonResponsibilities()
           
 String getPersonReviewer()
           
 String getPersonReviewerType()
           
 String getPreviousRuleId()
          Unique id for the previous version of this Rule.
 RuleBaseValues getPreviousVersion()
           
 RuleResponsibilityBo getResponsibility(int index)
           
 RuleResponsibilityBo getResponsibility(Long ruleResponsibilityKey)
           
 String getReturnUrl()
           
 List<RoleRuleResponsibility> getRoleResponsibilities()
           
 RuleExpressionDef getRuleExpressionDef()
          Expression for rule to evaluate.
 RuleExtensionBo getRuleExtension(int index)
           
 Map<String,String> getRuleExtensionMap()
           
 List<RuleExtensionBo> getRuleExtensions()
          List of rule extensions associated with the Rule
 RuleExtensionValue getRuleExtensionValue(String key)
           
 RuleExtensionValue getRuleExtensionValue(String ruleTemplateAttributeId, String key)
           
 List<RuleResponsibilityBo> getRuleResponsibilities()
          List of rule responsibilities associated with the Rule
 RuleTemplateBo getRuleTemplate()
          Unique Id for Template of Rule.
 String getRuleTemplateId()
           
 String getRuleTemplateName()
          Template Name of the Rule.
 Boolean getTemplateRuleInd()
           
 org.joda.time.DateTime getToDate()
          The ending date of the rule.
 String getToDateString()
           
 Timestamp getToDateValue()
           
 Integer getVersionNbr()
           
 boolean isActive()
          The active indicator for the rule.
 boolean isActive(Date date)
           
 boolean isForceAction()
          Shows if rule will force its action.
 boolean isMatch(DocumentContent docContent)
           
 void removeResponsibility(int index)
           
 void setActivationDate(Timestamp activationDate)
           
 void setActive(boolean active)
           
 void setCurrentInd(Boolean currentInd)
           
 void setDeactivationDate(Timestamp deactivationDate)
           
 void setDelegateRule(Boolean isDelegateRule)
           
 void setDescription(String description)
           
 void setDestinationUrl(String destinationUrl)
           
 void setDocTypeName(String docTypeName)
           
 void setDocumentId(String documentId)
           
 void setFieldValues(Map<String,String> fieldValues)
           
 void setForceAction(boolean forceAction)
           
 void setFromDateValue(Timestamp fromDateValue)
           
 void setGroupResponsibilities(List<GroupRuleResponsibility> groupResponsibilities)
           
 void setGroupReviewerName(String groupReviewerName)
           
 void setGroupReviewerNamespace(String groupReviewerNamespace)
           
 void setId(String id)
           
 void setMyColumns(MyColumns additionalColumns)
           
 void setName(String name)
          Set the rule name
 void setPersonResponsibilities(List<PersonRuleResponsibility> personResponsibilities)
           
 void setPersonReviewer(String personReviewer)
           
 void setPersonReviewerType(String personReviewerType)
           
 void setPreviousRuleId(String previousVersion)
           
 void setPreviousVersion(RuleBaseValues previousVersion)
           
 void setReturnUrl(String returnUrl)
           
 void setRoleResponsibilities(List<RoleRuleResponsibility> roleResponsibilities)
           
 void setRuleExpressionDef(RuleExpressionDef ruleExpressionDef)
           
 void setRuleExtensions(List<RuleExtensionBo> ruleExtensions)
           
 void setRuleResponsibilities(List<RuleResponsibilityBo> ruleResponsibilities)
           
 void setRuleTemplate(RuleTemplateBo ruleTemplate)
           
 void setRuleTemplateId(String ruleTemplateId)
           
 void setTemplateRuleInd(Boolean templateRuleInd)
           
 void setToDateValue(Timestamp toDateValue)
           
 void setVersionNbr(Integer versionNbr)
           
static Rule to(RuleBaseValues bo)
          Converts a mutable bo to its immutable counterpart
 
Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase
afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber
 
Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic
toString
 

Constructor Detail

RuleBaseValues

public RuleBaseValues()
Method Detail

getRuleExpressionDef

public RuleExpressionDef getRuleExpressionDef()
Description copied from interface: RuleContract
Expression for rule to evaluate.

This is expression definition of the rule

Specified by:
getRuleExpressionDef in interface RuleContract
Returns:
the rule expression definition for this rule, if defined

setRuleExpressionDef

public void setRuleExpressionDef(RuleExpressionDef ruleExpressionDef)
Parameters:
ruleExpressionDef - the rule expression definition to set for this rule

getRuleTemplateName

public String getRuleTemplateName()
Description copied from interface: RuleContract
Template Name of the Rule.

This is the name of the rule template for the rule

Specified by:
getRuleTemplateName in interface RuleContract
Returns:
ruleTemplateName

getPreviousVersion

public RuleBaseValues getPreviousVersion()

setPreviousVersion

public void setPreviousVersion(RuleBaseValues previousVersion)

getResponsibility

public RuleResponsibilityBo getResponsibility(int index)

getRuleExtension

public RuleExtensionBo getRuleExtension(int index)

getRuleExtensionValue

public RuleExtensionValue getRuleExtensionValue(String key)

getRuleExtensionValue

public RuleExtensionValue getRuleExtensionValue(String ruleTemplateAttributeId,
                                                String key)

getPreviousRuleId

public String getPreviousRuleId()
Description copied from interface: RuleContract
Unique id for the previous version of this Rule.

This is the unique id value of the previous version of this Rule.

Specified by:
getPreviousRuleId in interface RuleContract
Returns:
previousVersionId

setPreviousRuleId

public void setPreviousRuleId(String previousVersion)

addRuleResponsibility

public void addRuleResponsibility(RuleResponsibilityBo ruleResponsibility)

addRuleResponsibility

public void addRuleResponsibility(RuleResponsibilityBo ruleResponsibility,
                                  Integer counter)

getRuleTemplate

public RuleTemplateBo getRuleTemplate()
Description copied from interface: RuleContract
Unique Id for Template of Rule.

This is the unique Id of the rule template of the rule

Specified by:
getRuleTemplate in interface RuleContract
Returns:
ruleTemplateId

setRuleTemplate

public void setRuleTemplate(RuleTemplateBo ruleTemplate)

getRuleTemplateId

public String getRuleTemplateId()

setRuleTemplateId

public void setRuleTemplateId(String ruleTemplateId)

getDocumentType

public DocumentType getDocumentType()

getDocTypeName

public String getDocTypeName()
Description copied from interface: RuleContract
The documentTypeName of the rule.

Specified by:
getDocTypeName in interface RuleContract
Returns:
documentTypeName

setDocTypeName

public void setDocTypeName(String docTypeName)

getRuleExtensions

public List<RuleExtensionBo> getRuleExtensions()
Description copied from interface: RuleContract
List of rule extensions associated with the Rule

Specified by:
getRuleExtensions in interface RuleContract
Returns:
ruleExtensions

getRuleExtensionMap

public Map<String,String> getRuleExtensionMap()

setRuleExtensions

public void setRuleExtensions(List<RuleExtensionBo> ruleExtensions)

getRuleResponsibilities

public List<RuleResponsibilityBo> getRuleResponsibilities()
Description copied from interface: RuleContract
List of rule responsibilities associated with the Rule

Specified by:
getRuleResponsibilities in interface RuleContract
Returns:
ruleResponsibilities

setRuleResponsibilities

public void setRuleResponsibilities(List<RuleResponsibilityBo> ruleResponsibilities)

getResponsibility

public RuleResponsibilityBo getResponsibility(Long ruleResponsibilityKey)

removeResponsibility

public void removeResponsibility(int index)

isActive

public boolean isActive()
Description copied from interface: RuleContract
The active indicator for the rule.

Specified by:
isActive in interface RuleContract
Returns:
true if active false if not.

setActive

public void setActive(boolean active)

getActiveIndDisplay

public String getActiveIndDisplay()

getCurrentInd

public Boolean getCurrentInd()

setCurrentInd

public void setCurrentInd(Boolean currentInd)

getFromDateValue

public Timestamp getFromDateValue()

getFromDate

public org.joda.time.DateTime getFromDate()
Description copied from interface: RuleContract
The ending date of the rule.

This is the date from which the rule stops being be used

Specified by:
getFromDate in interface RuleContract
Returns:
fromDate

setFromDateValue

public void setFromDateValue(Timestamp fromDateValue)

getDescription

public String getDescription()
Description copied from interface: RuleContract
The description of the rule.

Specified by:
getDescription in interface RuleContract
Returns:
description

setDescription

public void setDescription(String description)

getId

public String getId()
Description copied from interface: Identifiable
The unique identifier for an object. This can be null.

Specified by:
getId in interface Identifiable
Returns:
the id

setId

public void setId(String id)

getToDateValue

public Timestamp getToDateValue()

getToDate

public org.joda.time.DateTime getToDate()
Description copied from interface: RuleContract
The ending date of the rule.

This is the date from which the rule starts to be used

Specified by:
getToDate in interface RuleContract
Returns:
toDate

setToDateValue

public void setToDateValue(Timestamp toDateValue)

getVersionNbr

public Integer getVersionNbr()

setVersionNbr

public void setVersionNbr(Integer versionNbr)

getReturnUrl

public String getReturnUrl()

setReturnUrl

public void setReturnUrl(String returnUrl)

getFromDateString

public String getFromDateString()

getToDateString

public String getToDateString()

isForceAction

public boolean isForceAction()
Description copied from interface: RuleContract
Shows if rule will force its action.

Specified by:
isForceAction in interface RuleContract
Returns:
boolean value representing if action is forced

setForceAction

public void setForceAction(boolean forceAction)

isActive

public boolean isActive(Date date)

isMatch

public boolean isMatch(DocumentContent docContent)

findResponsibility

public RuleResponsibilityBo findResponsibility(String roleName)

getDocumentId

public String getDocumentId()

setDocumentId

public void setDocumentId(String documentId)

getDelegateRule

public Boolean getDelegateRule()

setDelegateRule

public void setDelegateRule(Boolean isDelegateRule)

getActivationDate

public Timestamp getActivationDate()

setActivationDate

public void setActivationDate(Timestamp activationDate)

getMyColumns

public MyColumns getMyColumns()

setMyColumns

public void setMyColumns(MyColumns additionalColumns)

getDestinationUrl

public String getDestinationUrl()

setDestinationUrl

public void setDestinationUrl(String destinationUrl)

getDeactivationDate

public Timestamp getDeactivationDate()

setDeactivationDate

public void setDeactivationDate(Timestamp deactivationDate)

getTemplateRuleInd

public Boolean getTemplateRuleInd()
Returns:
whether this is a defaults/template rule

setTemplateRuleInd

public void setTemplateRuleInd(Boolean templateRuleInd)
Parameters:
templateRuleInd - whether this is a defaults/template rule

getName

public String getName()
Get the rule name

Specified by:
getName in interface RuleContract
Returns:
the rule name

setName

public void setName(String name)
Set the rule name

Parameters:
name - the rule name

getPersonResponsibilities

public List<PersonRuleResponsibility> getPersonResponsibilities()

setPersonResponsibilities

public void setPersonResponsibilities(List<PersonRuleResponsibility> personResponsibilities)

getGroupResponsibilities

public List<GroupRuleResponsibility> getGroupResponsibilities()

setGroupResponsibilities

public void setGroupResponsibilities(List<GroupRuleResponsibility> groupResponsibilities)

getRoleResponsibilities

public List<RoleRuleResponsibility> getRoleResponsibilities()

setRoleResponsibilities

public void setRoleResponsibilities(List<RoleRuleResponsibility> roleResponsibilities)

getFieldValues

public Map<String,String> getFieldValues()
Returns:
the fieldValues

setFieldValues

public void setFieldValues(Map<String,String> fieldValues)
Parameters:
fieldValues - the fieldValues to set

getGroupReviewerName

public String getGroupReviewerName()

getGroupReviewerNamespace

public String getGroupReviewerNamespace()

getPersonReviewer

public String getPersonReviewer()

setGroupReviewerName

public void setGroupReviewerName(String groupReviewerName)

setGroupReviewerNamespace

public void setGroupReviewerNamespace(String groupReviewerNamespace)

setPersonReviewer

public void setPersonReviewer(String personReviewer)

getGroupBo

public org.kuali.rice.kim.impl.group.GroupBo getGroupBo()

getPersonImpl

public PersonImpl getPersonImpl()

getPersonReviewerType

public String getPersonReviewerType()

setPersonReviewerType

public void setPersonReviewerType(String personReviewerType)

to

public static Rule to(RuleBaseValues bo)
Converts a mutable bo to its immutable counterpart

Parameters:
bo - the mutable business object
Returns:
the immutable object


Copyright © 2005-2013 The Kuali Foundation. All Rights Reserved.