Package wt.businessRules

Class BusinessRule

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.enterprise._Simple

wt.enterprise.Simple

wt.businessRules._BusinessRuleObject

wt.businessRules.BusinessRuleObject

wt.businessRules._BusinessRule

wt.businessRules.BusinessRule

All Implemented Interfaces:

com.ptc.windchill.bac._BACManaged, com.ptc.windchill.bac.BACManaged, Externalizable, Serializable, wt.access._AccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.businessRules.BusinessRuleObjectIfc, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, DisplayIdentification, wt.inf.container._WTContained, WTContained, wt.notify._Notifiable, Notifiable, wt.recent.RecentlyVisited

@GenAsPersistable(superClass=wt.businessRules.BusinessRuleObject.class,extendable=true,properties={@GeneratedProperty(name="config",type=java.util.HashMap.class,typeParameter="<String,String>",columnProperties=@ColumnProperties(columnType=INLINE_BLOB),supportedAPI=PRIVATE,javaDoc="A serialized Map that holds information to execute the rule"),@GeneratedProperty(name="selector",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="An identifier to lookup the rule validator class.",constraints=@PropertyConstraints(required=true,upperLimit=256))})
public class BusinessRule
extends _BusinessRule

A business object that will hold the information about the rules to be executed. A BusinessRule is a business object that will be linked to the RuleSet using a binary link RuleLink. The business rule object is executed as a part of the business rules engine execution plan. A set of rules are fetched for a rule set key, which is then executed by the rules engine to evaluate a particular rule. The results are populated in a validation object for each rule and returned as a set from the business rules engine.
The config attribute is used to hold the serialized information for executing the rule. At the rule execution, the config attribute will be de-serialized map, the structure should will be a key / value pair construct. For example, in the state check rule, key could be, "Release" --> "RELEASED,RESOLVED" and "PRE_RELEASE" --> "PROTOTYPE".
Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields inherited from class wt.businessRules._BusinessRule

CONFIG, EXTERNALIZATION_VERSION_UID, SELECTOR

Fields inherited from class wt.businessRules._BusinessRuleObject

DESCRIPTION, ENABLED, NAME, UNIQUE_KEY

Fields inherited from class wt.fc._WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.adminlock._AdministrativelyLockable

ADMINISTRATIVE_LOCK

Fields inherited from interface wt.admin._DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.notify._Notifiable

EVENT_SET

Fields inherited from interface wt.fc._Persistable

PERSIST_INFO

Fields inherited from interface wt.access._SecurityLabeled

SECURITY_LABELS

Fields inherited from interface wt.inf.container._WTContained

CONTAINER, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Fields inherited from interface wt.fc.Persistable

IDENTITY, TYPE

Fields inherited from interface wt.access.SecurityLabeled

SECURITY_LABELS_INTERNAL_VALUE

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID

Method Summary

Modifier and Type	Method	Description
static BusinessRule	newBusinessRule(String key, String selector)	Creates an instance of the BusinessRule object that holds the attribute information.
static BusinessRule	newBusinessRule(String key, String selector, String name, boolean enabled, HashMap<String,String> config)	Creates an instance of BusinessRule object that holds the attribute information.

Methods inherited from class wt.businessRules._BusinessRule

getClassInfo, getConceptualClassname, getConfig, getSelector, getType, readExternal, readExternal, readVersion, setConfig, setSelector, super_readExternal_BusinessRule, super_readVersion_BusinessRule, super_writeExternal_BusinessRule, writeExternal, writeExternal

Methods inherited from class wt.businessRules.BusinessRuleObject

getDescription, getDescription, getInternalDescription, getInternalName, getName, getName

Methods inherited from class wt.businessRules._BusinessRuleObject

getContainer, getContainerName, getContainerReference, getUniqueKey, isEnabled, readVersion, setContainer, setContainerReference, setDescription, setEnabled, setName, setUniqueKey, super_readExternal_BusinessRuleObject, super_readVersion_BusinessRuleObject, super_writeExternal_BusinessRuleObject

Methods inherited from class wt.enterprise.Simple

getBusinessType, getIdentity, initialize

Methods inherited from class wt.enterprise._Simple

getAdministrativeLock, getDomainRef, getEventSet, getSecurityLabels, isInheritedDomain, readVersion, setAdministrativeLock, setDomainRef, setEventSet, setInheritedDomain, setSecurityLabels, super_readExternal_Simple, super_readVersion_Simple, super_writeExternal_Simple

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, getDisplayIdentifier, getDisplayIdentity, getDisplayType, toString

Methods inherited from class wt.fc._WTObject

equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc._Persistable

getPersistInfo, setPersistInfo

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity

Method Details

newBusinessRule

public static BusinessRule newBusinessRule(String key,
 String selector,
 String name,
 boolean enabled,
 HashMap<String,String> config)
                                    throws WTException

Creates an instance of BusinessRule object that holds the attribute information.

Supported API: true

Parameters:

key -

selector -

name -

enabled -

config -

Returns:

Throws:

WTException

newBusinessRule

public static BusinessRule newBusinessRule(String key,
 String selector)
                                    throws WTException

Creates an instance of the BusinessRule object that holds the attribute information. Attribute enabled will be true, while as the name and the config will be set to null.

Supported API: true

Parameters:

key -

selector -

Returns:

Throws:

WTException