org.kuali.rice.kew.rule.web
Class WebRuleBaseValues

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.rice.kew.bo.KewPersistableBusinessObjectBase
              org.kuali.rice.kew.rule.RuleBaseValues
                  org.kuali.rice.kew.rule.web.WebRuleBaseValues

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, BusinessObject, PersistableBusinessObject

public class WebRuleBaseValues
extends RuleBaseValues

A decorator around a RuleBaseValues object which provides some convienance functions for interacting with the bean from the web-tier. This helps to alleviate some of the weaknesses of JSTL.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

WebRuleBaseValues()

WebRuleBaseValues(RuleBaseValues rule)

Method Summary

WebRuleResponsibility	createNewRuleResponsibility()
void	edit(RuleBaseValues rule) Populates this WebRuleBaseValues object for editing the given rule.
void	establishRequiredState() Establishes any missing and required state in the WebRuleBaseValues.
Map	getActionRequestCodes()
KeyValueId	getField(int index)
Map	getFieldMap(String ruleTemplateAttributeId)
List	getFields()
String	getFromDateValue()
Long	getParentRuleId()
int	getResponsibilitiesSize()
RuleResponsibility	getResponsibility(int index)
List	getRoles()
List	getRows()
RuleDelegation	getRuleDelegation()
String	getRuleTemplateName()
String	getToDateValue()
void	initialize()
boolean	isHasExtensionValueErrors()
void	load(RuleBaseValues rule) Loads the given rule into this WebRuleBaseValues.
void	loadFieldsWithDefaultValues()
void	materialize() This method is used to "materialize" the web rule before it gets saved, if we don't do this then certain fields will be saved as NULL.
void	populatePreviousVersionIds()
void	setFields(List fields)
void	setFromDateValue(String fromDateValue)
void	setHasExtensionValueErrors(boolean hasRuleExtensionValueErrors)
void	setRoles(List roles)
void	setRows(List ruleTemplateAttributes)
void	setRuleTemplateName(String ruleTemplateName)
void	setToDateValue(String toDateValue)
void	validateRule(String keyPrefix, org.apache.struts.action.ActionErrors errors)

Methods inherited from class org.kuali.rice.kew.rule.RuleBaseValues

addRuleResponsibility, addRuleResponsibility, copy, findResponsibility, getActivationDate, getActiveInd, getActiveIndDisplay, getCurrentInd, getDeactivationDate, getDelegateRule, getDescription, getDestinationUrl, getDocTypeName, getDocumentType, getFieldValues, getForceAction, getFromDate, getFromDateString, getGroupResponsibilities, getGroupReviewerName, getGroupReviewerNamespace, getKimGroupImpl, getMyColumns, getName, getPersonImpl, getPersonResponsibilities, getPersonReviewer, getPersonReviewerType, getPreviousVersion, getPreviousVersionId, getResponsibilities, getResponsibility, getReturnUrl, getRoleResponsibilities, getRouteHeaderId, getRuleBaseValuesId, getRuleExpressionDef, getRuleExtension, getRuleExtensions, getRuleExtensionValue, getRuleExtensionValue, getRuleExtensionValueLabels, getRuleTemplate, getRuleTemplateId, getTemplateRuleInd, getToDate, getToDateString, getVersionNbr, isActive, isMatch, removeResponsibility, setActivationDate, setActiveInd, setCurrentInd, setDeactivationDate, setDelegateRule, setDescription, setDestinationUrl, setDocTypeName, setFieldValues, setForceAction, setFromDate, setGroupResponsibilities, setGroupReviewerName, setGroupReviewerNamespace, setMyColumns, setName, setPersonResponsibilities, setPersonReviewer, setPersonReviewerType, setPreviousVersion, setPreviousVersionId, setResponsibilities, setReturnUrl, setRoleResponsibilities, setRouteHeaderId, setRuleBaseValuesId, setRuleExpressionDef, setRuleExtensions, setRuleTemplate, setRuleTemplateId, setTemplateRuleInd, setToDate, setVersionNbr, toStringMapper

Methods inherited from class org.kuali.rice.kew.bo.KewPersistableBusinessObjectBase

beforeInsert

Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

addNote, afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, beforeUpdate, buildListOfDeletionAwareLists, deleteNote, getAttachmentService, getBoNote, getBoNotes, getExtension, getNoteService, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isAutoIncrementSet, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setBoNotes, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber, supportsBoNotes

Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase

prepareForWorkflow, toString, toStringBuilder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.rice.kns.bo.BusinessObject

prepareForWorkflow

Constructor Detail

WebRuleBaseValues

public WebRuleBaseValues()

WebRuleBaseValues

public WebRuleBaseValues(RuleBaseValues rule)
                  throws Exception

Throws:

Exception

Method Detail

loadFieldsWithDefaultValues

public void loadFieldsWithDefaultValues()

getFields

public List getFields()

setFields

public void setFields(List fields)

getField

public KeyValueId getField(int index)

getFromDateValue

public String getFromDateValue()

setFromDateValue

public void setFromDateValue(String fromDateValue)

getRoles

public List getRoles()

setRoles

public void setRoles(List roles)

getRows

public List getRows()

setRows

public void setRows(List ruleTemplateAttributes)

getToDateValue

public String getToDateValue()

setToDateValue

public void setToDateValue(String toDateValue)

getRuleTemplateName

public String getRuleTemplateName()

Overrides:

getRuleTemplateName in class RuleBaseValues

setRuleTemplateName

public void setRuleTemplateName(String ruleTemplateName)

isHasExtensionValueErrors

public boolean isHasExtensionValueErrors()

setHasExtensionValueErrors

public void setHasExtensionValueErrors(boolean hasRuleExtensionValueErrors)

edit

public void edit(RuleBaseValues rule)
          throws Exception

Populates this WebRuleBaseValues object for editing the given rule.

Throws:

Exception

load

public void load(RuleBaseValues rule)
          throws Exception

Loads the given rule into this WebRuleBaseValues.

Throws:

Exception

initialize

public void initialize()
                throws Exception

Throws:

Exception

establishRequiredState

public void establishRequiredState()
                            throws Exception

Establishes any missing and required state in the WebRuleBaseValues.

Throws:

Exception

getResponsibility

public RuleResponsibility getResponsibility(int index)

Overrides:

getResponsibility in class RuleBaseValues

getResponsibilitiesSize

public int getResponsibilitiesSize()

createNewRuleResponsibility

public WebRuleResponsibility createNewRuleResponsibility()

getFieldMap

public Map getFieldMap(String ruleTemplateAttributeId)

populatePreviousVersionIds

public void populatePreviousVersionIds()

materialize

public void materialize()

This method is used to "materialize" the web rule before it gets saved, if we don't do this then certain fields will be saved as NULL. For example, ruleTemplate.

validateRule

public void validateRule(String keyPrefix,
                         org.apache.struts.action.ActionErrors errors)

getActionRequestCodes

public Map getActionRequestCodes()

Returns:

Returns the actionRequestCodes.

getRuleDelegation

public RuleDelegation getRuleDelegation()

getParentRuleId

public Long getParentRuleId()