com.ptc.netmarkets.model
Class NmNamedObject

java.lang.Object
  extended bycom.ptc.netmarkets.model.NmObject
      extended bycom.ptc.netmarkets.model.NmNamedObject
All Implemented Interfaces:
Comparable, Externalizable, NetFactor, NmActionTarget, NmFormatable, NmNamed, Serializable
Direct Known Subclasses:
NmActionItem, NmBookmark, NmBookmark, NmFolder, NmForum, NmGroup, NmMeeting, NmNotebook, NmNotebookFolder, NmOrg, NmPosting, NmProject, NmProjMgmtObject, NmReportTemplate, NmRole, NmRule, NmSubscription, NmTopic, NmUser, NmWorkableObject

public class NmNamedObject
extends NmObject
implements NmNamed, Comparable, Externalizable

Use the newNmNamedObject static factory method(s), not the NmNamedObject 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
           
static long EXTERNALIZATION_VERSION_UID
           
private  int maxNameLength
           
private  String name
           
static int NO_TRUCATION
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
static int 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
NmNamedObject()
           
 
Method Summary
 int compareTo(Object obj)
           
 String getConceptualClassname()
          Deprecated.  
 int getMaxNameLength()
          Gets the value of the attribute: maxNameLength.
 String getName()
          Gets the value of the attribute: name.
protected  void initialize(String type, Persistable object, String name)
          Supports initialization, following construction of an instance.
static NmNamedObject newNmNamedObject()
          

Supported API: false
static NmNamedObject newNmNamedObject(String type, Persistable object, String name)
          

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(NmNamedObject thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setMaxNameLength(int a_MaxNameLength)
          Sets the value of the attribute: maxNameLength.
 void setName(String a_Name)
          Sets the value of the attribute: name.
 void writeExternal(ObjectOutput output)
          Writes the non-transient fields of this class to an external source.
 
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

maxNameLength

private int maxNameLength

name

private String name

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

NO_TRUCATION

public static final int NO_TRUCATION
See Also:
Constant Field Values

USER_PREFERENCE

public static final int USER_PREFERENCE
See Also:
Constant Field Values
Constructor Detail

NmNamedObject

public NmNamedObject()
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 NmObject
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 NmObject
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(NmNamedObject 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 NmObject
Returns:
String

getMaxNameLength

public int getMaxNameLength()
Gets the value of the attribute: maxNameLength.

Supported API: false

Returns:
int

setMaxNameLength

public void setMaxNameLength(int a_MaxNameLength)
Sets the value of the attribute: maxNameLength.

Supported API: false

Parameters:
a_MaxNameLength -

newNmNamedObject

public static NmNamedObject newNmNamedObject()
                                      throws WTException


Supported API: false

Returns:
NmNamedObject
Throws:
WTException

newNmNamedObject

public static NmNamedObject newNmNamedObject(String type,
                                             Persistable object,
                                             String name)
                                      throws WTException


Supported API: false

Parameters:
type -
object -
name -
Returns:
NmNamedObject
Throws:
WTException

initialize

protected void initialize(String type,
                          Persistable object,
                          String name)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:
type -
object -
name -
Throws:
WTException

getName

public String getName()
Gets the value of the attribute: name.

Supported API: false

Specified by:
getName in interface NmNamed
Returns:
String

setName

public void setName(String a_Name)
Sets the value of the attribute: name.

Supported API: false

Specified by:
setName in interface NmNamed
Parameters:
a_Name -

compareTo

public int compareTo(Object obj)
Specified by:
compareTo in interface Comparable