com.ptc.netmarkets.rule
Class NmRuleServiceFwd

java.lang.Object
  com.ptc.netmarkets.rule.NmRuleServiceFwd

All Implemented Interfaces:

NmRuleService, RemoteAccess, Serializable

public class NmRuleServiceFwd

extends Object

implements RemoteAccess, NmRuleService, Serializable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private static String	FC_RESOURCE
(package private) static boolean	SERVER

Fields inherited from interface wt.method.RemoteAccess

versionID

Constructor Summary

NmRuleServiceFwd()

Method Summary

NmChangeModel[]	create(NmCommandBean cb, Hashtable params) Create a rule using the data in the request.
NmChangeModel[]	disable(NmCommandBean cb) Supported API: false
NmChangeModel[]	enable(NmCommandBean cb) Supported API: false
Enumeration	findTypes(Class objType, WTContainerRef container, boolean enabled) Find TypeBasedRules that are of type RuleType.TYPE and whose object type attribute equals objType.
private static Manager	getManager()
NmRule	getNmRule(NmCommandBean cb, Hashtable params) Get the rule from the specified container for the specified rule type and object type.
NmRule	getNmRule(Rule rule) Gets a NmRule for the specified rule.
NmRule	getNmRule(Rule rule, boolean includeSpec) Supported API: false
Rule	getRule(String name, RuleType ruleType, WTContainerRef container) Get the Rule that has the specified name and ruleType in the specified container.
String	getRuleObjectTypeFromPersistId(String ObjType) Supported API: false
NmRule	getRuleProperties(NmCommandBean cb, boolean includeSpec) Supported API: false
ArrayList	list(NmCommandBean cb) Supported API: false
ArrayList	listRulesForType(String className, NmOid projectOid) Supported API: false
NmChangeModel[]	update(NmCommandBean cb, Hashtable params) Update a rule using the data in the request.

Methods inherited from class java.lang.Object

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

Field Detail

SERVER

static final boolean SERVER

FC_RESOURCE

private static final String FC_RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Constructor Detail

NmRuleServiceFwd

public NmRuleServiceFwd()

Method Detail

getManager

private static Manager getManager()
                           throws WTException

Returns:

Manager

Throws:

WTException

list

public ArrayList list(NmCommandBean cb)
               throws WTException

Supported API: false

Specified by:

list in interface NmRuleService

Parameters:

cb -

Returns:

ArrayList

Throws:

WTException

listRulesForType

public ArrayList listRulesForType(String className,
                                  NmOid projectOid)
                           throws WTException

Supported API: false

Specified by:

listRulesForType in interface NmRuleService

Parameters:

className -

projectOid -

Returns:

ArrayList

Throws:

WTException

getRule

public Rule getRule(String name,
                    RuleType ruleType,
                    WTContainerRef container)
             throws WTException

Get the Rule that has the specified name and ruleType in the specified container. If no rule is found in the specified container, then its parent container is searched. This repeats until a rule is found or the top of the hierarchy is reached. If no such rule exists, return null.

Specified by:

getRule in interface NmRuleService

Parameters:

name - the rule name (cannot be null)

ruleType - the rule type (cannot be null)

container -

Returns:

Rule

Throws:

WTException

create

public NmChangeModel[] create(NmCommandBean cb,
                              Hashtable params)
                       throws WTException

Create a rule using the data in the request.

Supported API: false

Specified by:

create in interface NmRuleService

Parameters:

cb -

params - the request parameters

Returns:

NmChangeModel[]

Throws:

WTException

update

public NmChangeModel[] update(NmCommandBean cb,
                              Hashtable params)
                       throws WTException

Update a rule using the data in the request.

Supported API: false

Specified by:

update in interface NmRuleService

Parameters:

cb -

params -

Returns:

NmChangeModel[]

Throws:

WTException

enable

public NmChangeModel[] enable(NmCommandBean cb)
                       throws WTException

Supported API: false

Specified by:

enable in interface NmRuleService

Parameters:

cb -

Returns:

NmChangeModel[]

Throws:

WTException

disable

public NmChangeModel[] disable(NmCommandBean cb)
                        throws WTException

Supported API: false

Specified by:

disable in interface NmRuleService

Parameters:

cb -

Returns:

NmChangeModel[]

Throws:

WTException

getNmRule

public NmRule getNmRule(NmCommandBean cb,
                        Hashtable params)
                 throws WTException

Get the rule from the specified container for the specified rule type and object type.

Supported API: false

Specified by:

getNmRule in interface NmRuleService

Parameters:

cb -

params - the request parameters

Returns:

NmRule

Throws:

WTException

findTypes

public Enumeration findTypes(Class objType,
                             WTContainerRef container,
                             boolean enabled)
                      throws WTException

Find TypeBasedRules that are of type RuleType.TYPE and whose object type attribute equals objType.

If enabled is true then only return those rules that are enabled. If enabled is false then all matching rules are returned.

Supported API: false

Specified by:

findTypes in interface NmRuleService

Parameters:

objType - find rules that reference this object type

container - The container in which to search for types

enabled -

Returns:

Enumeration

Throws:

WTException

getNmRule

public NmRule getNmRule(Rule rule)
                 throws WTException

Gets a NmRule for the specified rule. Do not include the XML contents in the returned NmRule.

Supported API: false

Specified by:

getNmRule in interface NmRuleService

Parameters:

rule -

Returns:

NmRule

Throws:

WTException

getNmRule

public NmRule getNmRule(Rule rule,
                        boolean includeSpec)
                 throws WTException

Supported API: false

Specified by:

getNmRule in interface NmRuleService

Parameters:

rule -

includeSpec - if true include the XML specification in the returned

Returns:

NmRule

Throws:

WTException

getRuleProperties

public NmRule getRuleProperties(NmCommandBean cb,
                                boolean includeSpec)
                         throws WTException

Supported API: false

Specified by:

getRuleProperties in interface NmRuleService

Parameters:

cb -

includeSpec - if true, include the XML specification in the returned NmRule

Returns:

NmRule

Throws:

WTException

getRuleObjectTypeFromPersistId

public String getRuleObjectTypeFromPersistId(String ObjType)
                                      throws WTException

Supported API: false

Specified by:

getRuleObjectTypeFromPersistId in interface NmRuleService

Parameters:

ObjType -

Returns:

String

Throws:

WTException