org.kuali.rice.kew.rule
Class RuleBaseValues

java.lang.Object
  org.kuali.rice.krad.bo.BusinessObjectBase
      org.kuali.rice.krad.bo.PersistableBusinessObjectBase
          org.kuali.rice.kew.rule.RuleBaseValues

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, GloballyUnique, Versioned, ModelObjectBasic, BusinessObject, PersistableBusinessObject

Direct Known Subclasses:

WebRuleBaseValues

@Entity
public class RuleBaseValues
extends PersistableBusinessObjectBase

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(RuleResponsibility ruleResponsibility)
void	addRuleResponsibility(RuleResponsibility ruleResponsibility, Integer counter)
RuleResponsibility	findResponsibility(String roleName)
Timestamp	getActivationDate()
Boolean	getActiveInd()
String	getActiveIndDisplay()
Boolean	getCurrentInd()
Timestamp	getDeactivationDate()
Boolean	getDelegateRule()
String	getDescription()
String	getDestinationUrl()
String	getDocTypeName()
String	getDocumentId()
DocumentType	getDocumentType()
Map<String,String>	getFieldValues()
Boolean	getForceAction()
Timestamp	getFromDate()
String	getFromDateString()
List<GroupRuleResponsibility>	getGroupResponsibilities()
String	getGroupReviewerName()
String	getGroupReviewerNamespace()
MyColumns	getMyColumns()
String	getName() Get the rule name
PersonImpl	getPersonImpl()
List<PersonRuleResponsibility>	getPersonResponsibilities()
String	getPersonReviewer()
String	getPersonReviewerType()
RuleBaseValues	getPreviousVersion()
String	getPreviousVersionId()
List<RuleResponsibility>	getResponsibilities()
RuleResponsibility	getResponsibility(int index)
RuleResponsibility	getResponsibility(Long ruleResponsibilityKey)
String	getReturnUrl()
List<RoleRuleResponsibility>	getRoleResponsibilities()
String	getRuleBaseValuesId()
RuleExpressionDef	getRuleExpressionDef()
RuleExtension	getRuleExtension(int index)
List<RuleExtension>	getRuleExtensions()
RuleExtensionValue	getRuleExtensionValue(String key)
RuleExtensionValue	getRuleExtensionValue(String ruleTemplateAttributeId, String key)
Map	getRuleExtensionValueLabels()
RuleTemplate	getRuleTemplate()
String	getRuleTemplateId()
String	getRuleTemplateName()
Boolean	getTemplateRuleInd()
Timestamp	getToDate()
String	getToDateString()
Integer	getVersionNbr()
boolean	isActive(Date date)
boolean	isMatch(DocumentContent docContent)
void	removeResponsibility(int index)
void	setActivationDate(Timestamp activationDate)
void	setActiveInd(Boolean activeInd)
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	setFromDate(Timestamp fromDate)
void	setGroupResponsibilities(List<GroupRuleResponsibility> groupResponsibilities)
void	setGroupReviewerName(String groupReviewerName)
void	setGroupReviewerNamespace(String groupReviewerNamespace)
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	setPreviousVersion(RuleBaseValues previousVersion)
void	setPreviousVersionId(String previousVersion)
void	setResponsibilities(List<RuleResponsibility> responsibilities)
void	setReturnUrl(String returnUrl)
void	setRoleResponsibilities(List<RoleRuleResponsibility> roleResponsibilities)
void	setRuleBaseValuesId(String ruleBaseValuesId)
void	setRuleExpressionDef(RuleExpressionDef ruleExpressionDef)
void	setRuleExtensions(List<RuleExtension> ruleExtensions)
void	setRuleTemplate(RuleTemplate ruleTemplate)
void	setRuleTemplateId(String ruleTemplateId)
void	setTemplateRuleInd(Boolean templateRuleInd)
void	setToDate(Timestamp toDate)
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

prepareForWorkflow, toString, toStringBuilder, toStringMapper

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()

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

getRuleExtensionValueLabels

public Map getRuleExtensionValueLabels()

getRuleTemplateName

public String getRuleTemplateName()

getPreviousVersion

public RuleBaseValues getPreviousVersion()

setPreviousVersion

public void setPreviousVersion(RuleBaseValues previousVersion)

getResponsibility

public RuleResponsibility getResponsibility(int index)

getRuleExtension

public RuleExtension getRuleExtension(int index)

getRuleExtensionValue

public RuleExtensionValue getRuleExtensionValue(String key)

getRuleExtensionValue

public RuleExtensionValue getRuleExtensionValue(String ruleTemplateAttributeId,
                                                String key)

getPreviousVersionId

public String getPreviousVersionId()

setPreviousVersionId

public void setPreviousVersionId(String previousVersion)

addRuleResponsibility

public void addRuleResponsibility(RuleResponsibility ruleResponsibility)

addRuleResponsibility

public void addRuleResponsibility(RuleResponsibility ruleResponsibility,
                                  Integer counter)

getRuleTemplate

public RuleTemplate getRuleTemplate()

setRuleTemplate

public void setRuleTemplate(RuleTemplate ruleTemplate)

getRuleTemplateId

public String getRuleTemplateId()

setRuleTemplateId

public void setRuleTemplateId(String ruleTemplateId)

getDocumentType

public DocumentType getDocumentType()

getDocTypeName

public String getDocTypeName()

setDocTypeName

public void setDocTypeName(String docTypeName)

getRuleExtensions

public List<RuleExtension> getRuleExtensions()

setRuleExtensions

public void setRuleExtensions(List<RuleExtension> ruleExtensions)

getResponsibilities

public List<RuleResponsibility> getResponsibilities()

setResponsibilities

public void setResponsibilities(List<RuleResponsibility> responsibilities)

getResponsibility

public RuleResponsibility getResponsibility(Long ruleResponsibilityKey)

removeResponsibility

public void removeResponsibility(int index)

getActiveInd

public Boolean getActiveInd()

setActiveInd

public void setActiveInd(Boolean activeInd)

getActiveIndDisplay

public String getActiveIndDisplay()

getCurrentInd

public Boolean getCurrentInd()

setCurrentInd

public void setCurrentInd(Boolean currentInd)

getFromDate

public Timestamp getFromDate()

setFromDate

public void setFromDate(Timestamp fromDate)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getRuleBaseValuesId

public String getRuleBaseValuesId()

setRuleBaseValuesId

public void setRuleBaseValuesId(String ruleBaseValuesId)

getToDate

public Timestamp getToDate()

setToDate

public void setToDate(Timestamp toDate)

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()

getForceAction

public Boolean getForceAction()

setForceAction

public void setForceAction(Boolean forceAction)

isActive

public boolean isActive(Date date)

isMatch

public boolean isMatch(DocumentContent docContent)

findResponsibility

public RuleResponsibility 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

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)

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