com.ptc.netmarkets.role
Class NmRole

java.lang.Object
  com.ptc.netmarkets.model.NmObject
      com.ptc.netmarkets.model.NmNamedObject
          com.ptc.netmarkets.role.NmRole

All Implemented Interfaces:

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

public class NmRole

extends NmNamedObject

implements NmDescribed, Externalizable

Use the newNmRole static factory method(s), not the NmRole 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	description
static long	EXTERNALIZATION_VERSION_UID
static String	GUEST
private String	internalName
protected static long	OLD_FORMAT_VERSION_UID
private NmOid	projectOid
private static String	RESOURCE
(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.NmDescribed

DESCRIPTION

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

NmRole()

Method Summary

String	getConceptualClassname() Deprecated.
String	getDescription() Gets the value of the attribute: description.
String	getInternalName() Gets the value of the attribute: internalName.
static NmRole	getNmGuestRole() Supported API: false
NmOid	getProjectOid() Gets the value of the attribute: projectOid.
static NmRole	newNmRole() 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(NmRole thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDescription(String a_Description) Sets the value of the attribute: description.
void	setInternalName(String a_InternalName) Sets the value of the attribute: internalName.
void	setProjectOid(NmOid a_ProjectOid) Sets the value of the attribute: projectOid.
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, checkAvailable, 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

projectOid

private NmOid projectOid

internalName

private String internalName

description

private String description

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

GUEST

public static final String GUEST

See Also:

Constant Field Values

Constructor Detail

NmRole

public NmRole()

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(NmRole 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

getProjectOid

public NmOid getProjectOid()

Gets the value of the attribute: projectOid.

Supported API: false

Returns:

NmOid

setProjectOid

public void setProjectOid(NmOid a_ProjectOid)

Sets the value of the attribute: projectOid.

Supported API: false

Parameters:

a_ProjectOid -

getInternalName

public String getInternalName()

Gets the value of the attribute: internalName.

Supported API: false

Returns:

String

setInternalName

public void setInternalName(String a_InternalName)

Sets the value of the attribute: internalName.

Supported API: false

Parameters:

a_InternalName -

getNmGuestRole

public static NmRole getNmGuestRole()
                             throws WTException

Supported API: false

Returns:

NmRole

Throws:

WTException

newNmRole

public static NmRole newNmRole()
                        throws WTException

Default factory for the class.

Supported API: false

Returns:

NmRole

Throws:

WTException

getDescription

public String getDescription()

Gets the value of the attribute: description.

Supported API: false

Specified by:

getDescription in interface NmDescribed

Returns:

String

setDescription

public void setDescription(String a_Description)

Sets the value of the attribute: description.

Supported API: false

Specified by:

setDescription in interface NmDescribed

Parameters:

a_Description -