com.ptc.netmarkets.rule
Class NmRule

java.lang.Object
  com.ptc.netmarkets.model.NmObject
      com.ptc.netmarkets.model.NmNamedObject
          com.ptc.netmarkets.rule.NmRule

All Implemented Interfaces:

Comparable, Externalizable, NetFactor, NmActionTarget, NmFormatable, NmNamed, Serializable

public class NmRule

extends NmNamedObject

implements Externalizable

Use the newNmRule static factory method(s), not the NmRule constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private String	contents
private boolean	enabled
private String	encoding
static long	EXTERNALIZATION_VERSION_UID
private String	lifeCycle
private String	objType
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
private RuleType	ruleType
(package private) static long	serialVersionUID
static String	TYPE Supported API: false

Fields inherited from class com.ptc.netmarkets.model.NmNamedObject

NO_TRUCATION, USER_PREFERENCE

Fields inherited from class com.ptc.netmarkets.model.NmObject

ADDITIONAL_INFO, MARKED_FOR_DELETE, OID, RESTORABLE, VIEW_ACTION, VIEW_URL

Fields inherited from interface com.ptc.netmarkets.model.NmNamed

NAME

Fields inherited from interface com.ptc.netmarkets.util.misc.NmFormatable

DIV_CLASS, RENDER_WHILE_HIDDEN

Constructor Summary

NmRule()

Method Summary

boolean	checkAvailable(NmAction action, WTContainer container, HashMap checkInfo) Supported API: false
String	getConceptualClassname() Deprecated.
String	getContents() Gets the value of the attribute: contents; the XML content of the rule Supported API: false
String	getEncoding() Gets the value of the attribute: encoding; the encoding used for the XML content of the rule Supported API: false
String	getLifeCycle() Gets the value of the attribute: lifeCycle.
String	getObjType() Gets the value of the attribute: objType; For TypeBasedRules this is the value of the OBJ_TYPE attribute (i.e., the name of the type that the rule is associated with).
RuleType	getRuleType() Gets the value of the attribute: ruleType; The rule's RuleType.
boolean	isEnabled() Gets the value of the attribute: enabled.
static NmRule	newNmRule() Default factory for the class.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(NmRule thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setContents(String a_Contents) Sets the value of the attribute: contents; the XML content of the rule Supported API: false
void	setEnabled(boolean a_Enabled) Sets the value of the attribute: enabled.
void	setEncoding(String a_Encoding) Sets the value of the attribute: encoding; the encoding used for the XML content of the rule Supported API: false
void	setLifeCycle(String a_LifeCycle) Sets the value of the attribute: lifeCycle.
void	setObjType(String a_ObjType) Sets the value of the attribute: objType; For TypeBasedRules this is the value of the OBJ_TYPE attribute (i.e., the name of the type that the rule is associated with).
void	setRuleType(RuleType a_RuleType) Sets the value of the attribute: ruleType; The rule's RuleType.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class com.ptc.netmarkets.model.NmNamedObject

compareTo, getMaxNameLength, getName, initialize, newNmNamedObject, newNmNamedObject, readVersion, setMaxNameLength, setName

Methods inherited from class com.ptc.netmarkets.model.NmObject

checkAccess, checkAccess, getAdditionalInfo, getClassInfo, getCollationKey, getDivClass, getOid, getViewAction, getViewUrl, initialize, initialize, isAdmin, isAdmin, isExchangeAdmin, isMarkedForDelete, isRenderWhileHidden, isRestorable, newNmObject, newNmObject, readVersion, setAdditionalInfo, setCollationKey, setDivClass, setMarkedForDelete, setOid, setRenderWhileHidden, setRestorable, setViewAction, setViewUrl, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

TYPE

public static final String TYPE

Supported API: false

See Also:

Constant Field Values

enabled

private boolean enabled

lifeCycle

private String lifeCycle

ruleType

private RuleType ruleType

objType

private String objType

contents

private String contents

encoding

private String encoding

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

NmRule

public NmRule()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class NmNamedObject

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class NmNamedObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(NmRule thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Overrides:

getConceptualClassname in class NmNamedObject

Returns:

String

isEnabled

public boolean isEnabled()

Gets the value of the attribute: enabled.

Supported API: false

Returns:

boolean

setEnabled

public void setEnabled(boolean a_Enabled)

Sets the value of the attribute: enabled.

Supported API: false

Parameters:

a_Enabled -

getLifeCycle

public String getLifeCycle()

Gets the value of the attribute: lifeCycle.

Supported API: false

Returns:

String

setLifeCycle

public void setLifeCycle(String a_LifeCycle)

Sets the value of the attribute: lifeCycle.

Supported API: false

Parameters:

a_LifeCycle -

getRuleType

public RuleType getRuleType()

Gets the value of the attribute: ruleType; The rule's RuleType.

Supported API: false

Returns:

RuleType

setRuleType

public void setRuleType(RuleType a_RuleType)

Sets the value of the attribute: ruleType; The rule's RuleType.

Supported API: false

Parameters:

a_RuleType -

getObjType

public String getObjType()

Gets the value of the attribute: objType; For TypeBasedRules this is the value of the OBJ_TYPE attribute (i.e., the name of the type that the rule is associated with). For other kinds of rules this is null.

Supported API: false

Returns:

String

setObjType

public void setObjType(String a_ObjType)

Sets the value of the attribute: objType; For TypeBasedRules this is the value of the OBJ_TYPE attribute (i.e., the name of the type that the rule is associated with). For other kinds of rules this is null.

Supported API: false

Parameters:

a_ObjType -

getContents

public String getContents()

Gets the value of the attribute: contents; the XML content of the rule

Supported API: false

Returns:

String

setContents

public void setContents(String a_Contents)

Sets the value of the attribute: contents; the XML content of the rule

Supported API: false

Parameters:

a_Contents -

getEncoding

public String getEncoding()

Gets the value of the attribute: encoding; the encoding used for the XML content of the rule

Supported API: false

Returns:

String

setEncoding

public void setEncoding(String a_Encoding)

Sets the value of the attribute: encoding; the encoding used for the XML content of the rule

Supported API: false

Parameters:

a_Encoding -

newNmRule

public static NmRule newNmRule()
                        throws WTException

Default factory for the class.

Supported API: false

Returns:

NmRule

Throws:

WTException

checkAvailable

public boolean checkAvailable(NmAction action,
                              WTContainer container,
                              HashMap checkInfo)

Description copied from class: NmObject

Supported API: false

Specified by:

checkAvailable in interface NmActionTarget

Overrides:

checkAvailable in class NmObject

Parameters:

action -

container -

checkInfo -

Returns:

boolean