com.ptc.netmarkets.model
Class NmObject

java.lang.Object
  com.ptc.netmarkets.model.NmObject

All Implemented Interfaces:

Externalizable, NetFactor, NmActionTarget, NmFormatable, Serializable

Direct Known Subclasses:

NmNamedObject, NmObjectToObjectLink, NmSite

public class NmObject

extends Object

implements NmActionTarget, NetFactor, NmFormatable, Externalizable

Use the newNmObject static factory method(s), not the NmObject 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

static String	ADDITIONAL_INFO Label for the attribute.
private HashMap	additionalInfo
private static String	ALLOW_PM_UTILITIES
private static String	CLASSNAME
private CollationKey	collKey
private String	divClass
static long	EXTERNALIZATION_VERSION_UID
static String	MARKED_FOR_DELETE Label for the attribute.
private boolean	markedForDelete
private NmOid	oid
static String	OID Label for the attribute.
protected static long	OLD_FORMAT_VERSION_UID
private boolean	renderWhileHidden
private static String	RESOURCE
private boolean	restorable
static String	RESTORABLE Label for the attribute.
(package private) static long	serialVersionUID
static String	VIEW_ACTION Label for the attribute.
static String	VIEW_URL Label for the attribute.
private NmAction	viewAction
private String	viewUrl

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

DIV_CLASS, RENDER_WHILE_HIDDEN

Constructor Summary

NmObject()

Method Summary

boolean	checkAccess(String accessName) Supported API: false
boolean	checkAccess(String[] accessName) Supported API: false
boolean	checkAvailable(NmAction actionName, WTContainer container, HashMap checkInfo) Supported API: false
HashMap	getAdditionalInfo() Gets the value of the attribute: ADDITIONAL_INFO.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
CollationKey	getCollationKey()
String	getConceptualClassname() Deprecated.
String	getDivClass() Gets the value of the attribute: DIV_CLASS.
NmOid	getOid() Gets the value of the attribute: OID.
NmAction	getViewAction() Gets the value of the attribute: VIEW_ACTION.
String	getViewUrl() Gets the value of the attribute: VIEW_URL.
void	initialize() Supported API: false
protected void	initialize(NmOid oid) Supports initialization, following construction of an instance.
boolean	isAdmin(WTContainer container, HashMap checkInfo)
boolean	isAdmin(WTContainerRef ref, HashMap checkInfo)
boolean	isExchangeAdmin(HashMap checkInfo)
boolean	isMarkedForDelete() Gets the value of the attribute: MARKED_FOR_DELETE.
boolean	isRenderWhileHidden() Gets the value of the attribute: RENDER_WHILE_HIDDEN.
boolean	isRestorable() Gets the value of the attribute: RESTORABLE.
static NmObject	newNmObject() Supported API: false
static NmObject	newNmObject(NmOid oid) Supported API: false
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(NmObject thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAdditionalInfo(HashMap a_AdditionalInfo) Sets the value of the attribute: ADDITIONAL_INFO.
void	setCollationKey(CollationKey akey)
void	setDivClass(String a_DivClass) Sets the value of the attribute: DIV_CLASS.
void	setMarkedForDelete(boolean a_MarkedForDelete) Sets the value of the attribute: MARKED_FOR_DELETE.
void	setOid(NmOid a_Oid) Sets the value of the attribute: OID.
void	setRenderWhileHidden(boolean a_RenderWhileHidden) Sets the value of the attribute: RENDER_WHILE_HIDDEN.
void	setRestorable(boolean a_Restorable) Sets the value of the attribute: RESTORABLE.
void	setViewAction(NmAction a_ViewAction) Sets the value of the attribute: VIEW_ACTION.
void	setViewUrl(String a_ViewUrl) Sets the value of the attribute: VIEW_URL.
String	toString() Returns the conceptual (modeled) name for the class.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

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

OID

public static final String OID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

oid

private NmOid oid

ADDITIONAL_INFO

public static final String ADDITIONAL_INFO

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

additionalInfo

private HashMap additionalInfo

VIEW_ACTION

public static final String VIEW_ACTION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

viewAction

private NmAction viewAction

VIEW_URL

public static final String VIEW_URL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

viewUrl

private String viewUrl

MARKED_FOR_DELETE

public static final String MARKED_FOR_DELETE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

markedForDelete

private boolean markedForDelete

RESTORABLE

public static final String RESTORABLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

restorable

private boolean restorable

divClass

private String divClass

renderWhileHidden

private boolean renderWhileHidden

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

ALLOW_PM_UTILITIES

private static final String ALLOW_PM_UTILITIES

See Also:

Constant Field Values

collKey

private transient CollationKey collKey

Constructor Detail

NmObject

public NmObject()

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

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

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(NmObject 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

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getOid

public NmOid getOid()

Gets the value of the attribute: OID.

Supported API: false

Returns:

NmOid

setOid

public void setOid(NmOid a_Oid)

Sets the value of the attribute: OID.

Supported API: false

Parameters:

a_Oid -

getAdditionalInfo

public HashMap getAdditionalInfo()

Gets the value of the attribute: ADDITIONAL_INFO.

Supported API: false

Returns:

HashMap

setAdditionalInfo

public void setAdditionalInfo(HashMap a_AdditionalInfo)

Sets the value of the attribute: ADDITIONAL_INFO.

Supported API: false

Parameters:

a_AdditionalInfo -

getViewAction

public NmAction getViewAction()

Gets the value of the attribute: VIEW_ACTION.

Supported API: false

Returns:

NmAction

setViewAction

public void setViewAction(NmAction a_ViewAction)

Sets the value of the attribute: VIEW_ACTION.

Supported API: false

Parameters:

a_ViewAction -

getViewUrl

public String getViewUrl()

Gets the value of the attribute: VIEW_URL.

Supported API: false

Returns:

String

setViewUrl

public void setViewUrl(String a_ViewUrl)

Sets the value of the attribute: VIEW_URL.

Supported API: false

Parameters:

a_ViewUrl -

isMarkedForDelete

public boolean isMarkedForDelete()

Gets the value of the attribute: MARKED_FOR_DELETE.

Supported API: false

Returns:

boolean

setMarkedForDelete

public void setMarkedForDelete(boolean a_MarkedForDelete)

Sets the value of the attribute: MARKED_FOR_DELETE.

Supported API: false

Parameters:

a_MarkedForDelete -

isRestorable

public boolean isRestorable()

Gets the value of the attribute: RESTORABLE.

Supported API: false

Returns:

boolean

setRestorable

public void setRestorable(boolean a_Restorable)

Sets the value of the attribute: RESTORABLE.

Supported API: false

Parameters:

a_Restorable -

initialize

public void initialize()

Supported API: false

newNmObject

public static NmObject newNmObject()
                            throws WTException

Supported API: false

Returns:

NmObject

Throws:

WTException

newNmObject

public static NmObject newNmObject(NmOid oid)
                            throws WTException

Supported API: false

Parameters:

oid -

Returns:

NmObject

Throws:

WTException

initialize

protected void initialize(NmOid oid)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

oid -

Throws:

WTException

checkAvailable

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

Supported API: false

Specified by:

checkAvailable in interface NmActionTarget

Parameters:

actionName -

container -

checkInfo -

Returns:

boolean

checkAccess

public boolean checkAccess(String accessName)

Supported API: false

Specified by:

checkAccess in interface NmActionTarget

Parameters:

accessName -

Returns:

boolean

checkAccess

public boolean checkAccess(String[] accessName)

Supported API: false

Specified by:

checkAccess in interface NmActionTarget

Parameters:

accessName -

Returns:

boolean

getDivClass

public String getDivClass()

Gets the value of the attribute: DIV_CLASS.

Supported API: false

Specified by:

getDivClass in interface NmFormatable

Returns:

String

setDivClass

public void setDivClass(String a_DivClass)

Sets the value of the attribute: DIV_CLASS.

Supported API: false

Specified by:

setDivClass in interface NmFormatable

Parameters:

a_DivClass -

isRenderWhileHidden

public boolean isRenderWhileHidden()

Gets the value of the attribute: RENDER_WHILE_HIDDEN.

Supported API: false

Specified by:

isRenderWhileHidden in interface NmFormatable

Returns:

boolean

setRenderWhileHidden

public void setRenderWhileHidden(boolean a_RenderWhileHidden)

Sets the value of the attribute: RENDER_WHILE_HIDDEN.

Supported API: false

Specified by:

setRenderWhileHidden in interface NmFormatable

Parameters:

a_RenderWhileHidden -

isAdmin

public boolean isAdmin(WTContainer container,
                       HashMap checkInfo)

isAdmin

public boolean isAdmin(WTContainerRef ref,
                       HashMap checkInfo)

isExchangeAdmin

public boolean isExchangeAdmin(HashMap checkInfo)

setCollationKey

public void setCollationKey(CollationKey akey)

getCollationKey

public CollationKey getCollationKey()