com.ptc.netmarkets.subscription
Class NmSubscription

java.lang.Object
  extended bycom.ptc.netmarkets.model.NmObject
      extended bycom.ptc.netmarkets.model.NmNamedObject
          extended bycom.ptc.netmarkets.subscription.NmSubscription
All Implemented Interfaces:
Comparable, Externalizable, NetFactor, NmActionTarget, NmFormatable, NmNamed, Serializable

public class NmSubscription
extends NmNamedObject
implements Externalizable

Use the newNmSubscription static factory method(s), not the NmSubscription 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  Date expirationDate
           
static long EXTERNALIZATION_VERSION_UID
           
private  String message
           
protected static long OLD_FORMAT_VERSION_UID
           
private  String project
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
private  String subject
           
private  NmNamedObject subjectObject
           
private  String subscribeEvent
           
private  NmUser subscriber
           
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
NmSubscription()
           
 
Method Summary
 String getConceptualClassname()
          Deprecated.  
 Date getExpirationDate()
          Gets the value of the attribute: expirationDate.
 String getMessage()
          Gets the value of the attribute: message.
 String getProject()
          Gets the value of the attribute: project.
 String getSubject()
          Gets the value of the attribute: subject.
 NmNamedObject getSubjectObject()
          Gets the value of the attribute: subjectObject.
 String getSubscribeEvent()
          Gets the value of the attribute: subscribeEvent.
 NmUser getSubscriber()
          Gets the value of the attribute: subscriber.
static NmSubscription newNmSubscription()
          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(NmSubscription thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setExpirationDate(Date a_ExpirationDate)
          Sets the value of the attribute: expirationDate.
 void setMessage(String a_Message)
          Sets the value of the attribute: message.
 void setProject(String a_Project)
          Sets the value of the attribute: project.
 void setSubject(String a_Subject)
          Sets the value of the attribute: subject.
 void setSubjectObject(NmNamedObject a_SubjectObject)
          Sets the value of the attribute: subjectObject.
 void setSubscribeEvent(String a_SubscribeEvent)
          Sets the value of the attribute: subscribeEvent.
 void setSubscriber(NmUser a_Subscriber)
          Sets the value of the attribute: subscriber.
 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

project

private String project

message

private String message

subscriber

private NmUser subscriber

expirationDate

private Date expirationDate

subject

private String subject

subjectObject

private NmNamedObject subjectObject

subscribeEvent

private String subscribeEvent

TYPE

public static final String TYPE


Supported API: false

See Also:
Constant Field Values

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

NmSubscription

public NmSubscription()
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(NmSubscription 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

getProject

public String getProject()
Gets the value of the attribute: project.

Supported API: false

Returns:
String

setProject

public void setProject(String a_Project)
Sets the value of the attribute: project.

Supported API: false

Parameters:
a_Project -

getMessage

public String getMessage()
Gets the value of the attribute: message.

Supported API: false

Returns:
String

setMessage

public void setMessage(String a_Message)
Sets the value of the attribute: message.

Supported API: false

Parameters:
a_Message -

getSubscriber

public NmUser getSubscriber()
Gets the value of the attribute: subscriber.

Supported API: false

Returns:
NmUser

setSubscriber

public void setSubscriber(NmUser a_Subscriber)
Sets the value of the attribute: subscriber.

Supported API: false

Parameters:
a_Subscriber -

getExpirationDate

public Date getExpirationDate()
Gets the value of the attribute: expirationDate.

Supported API: false

Returns:
Date

setExpirationDate

public void setExpirationDate(Date a_ExpirationDate)
Sets the value of the attribute: expirationDate.

Supported API: false

Parameters:
a_ExpirationDate -

getSubject

public String getSubject()
Gets the value of the attribute: subject.

Supported API: false

Returns:
String

setSubject

public void setSubject(String a_Subject)
Sets the value of the attribute: subject.

Supported API: false

Parameters:
a_Subject -

getSubjectObject

public NmNamedObject getSubjectObject()
Gets the value of the attribute: subjectObject.

Supported API: false

Returns:
NmNamedObject

setSubjectObject

public void setSubjectObject(NmNamedObject a_SubjectObject)
Sets the value of the attribute: subjectObject.

Supported API: false

Parameters:
a_SubjectObject -

getSubscribeEvent

public String getSubscribeEvent()
Gets the value of the attribute: subscribeEvent.

Supported API: false

Returns:
String

setSubscribeEvent

public void setSubscribeEvent(String a_SubscribeEvent)
Sets the value of the attribute: subscribeEvent.

Supported API: false

Parameters:
a_SubscribeEvent -

newNmSubscription

public static NmSubscription newNmSubscription()
                                        throws WTException
Default factory for the class.

Supported API: false

Returns:
NmSubscription
Throws:
WTException