com.ptc.netmarkets.document
Class NmDocument

java.lang.Object
  com.ptc.netmarkets.model.NmObject
      com.ptc.netmarkets.model.NmNamedObject
          com.ptc.netmarkets.model.NmWorkableObject
              com.ptc.netmarkets.document.NmDocument

All Implemented Interfaces:

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

public class NmDocument

extends NmWorkableObject

implements NmDescribed, Externalizable

Use the newNmDocument static factory method(s), not the NmDocument 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 static boolean	DEBUG
private String	description
private boolean	enabled
static long	EXTERNALIZATION_VERSION_UID
private String	file
private boolean	hasContents
private boolean	isTemplate
private String	location
private String	number
protected static long	OLD_FORMAT_VERSION_UID
private String	organizationDN
private static String	RESOURCE
(package private) static long	serialVersionUID
private String	type
static String	TYPE Supported API: false

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

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.NmWorkable

AVAIL_FOR_ROLLUP_ITERATIONS, CHECKED_OUT_BY, CHECKED_OUT_OWNER, CHECKEDOUT, CONTAINER_NAME, LAST_MODIFIED, TYPE_ID

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

NmDocument()

Method Summary

boolean	checkAvailable(NmAction action, WTContainer container, HashMap checkInfo) Supported API: false
String	getConceptualClassname() Deprecated.
String	getDescription() Gets the value of the attribute: description.
String	getFile() Gets the value of the attribute: file.
String	getLocation() Gets the value of the attribute: location.
String	getNumber() Gets the value of the attribute: number.
String	getOrganizationDN() Gets the value of the attribute: organizationDN.
String	getType() Gets the value of the attribute: type.
boolean	isEnabled() Gets the value of the attribute: enabled.
boolean	isHasContents() Gets the value of the attribute: hasContents.
boolean	isIsTemplate() Gets the value of the attribute: isTemplate.
static NmDocument	newNmDocument() 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(NmDocument 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	setEnabled(boolean a_Enabled) Sets the value of the attribute: enabled.
void	setFile(String a_File) Sets the value of the attribute: file.
void	setHasContents(boolean a_HasContents) Sets the value of the attribute: hasContents.
void	setIsTemplate(boolean a_IsTemplate) Sets the value of the attribute: isTemplate.
void	setLocation(String a_Location) Sets the value of the attribute: location.
void	setNumber(String a_Number) Sets the value of the attribute: number.
void	setOrganizationDN(String a_OrganizationDN) Sets the value of the attribute: organizationDN.
void	setType(String a_Type) Sets the value of the attribute: type.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

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

getCheckedOutBy, getContainerName, getLastModified, getTypeId, isAvailForRollupIterations, isCheckedout, isCheckedOutOwner, newNmWorkableObject, readVersion, setAvailForRollupIterations, setCheckedout, setCheckedOutBy, setCheckedOutOwner, setContainerName, setLastModified, setTypeId

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

hasContents

private boolean hasContents

isTemplate

private boolean isTemplate

location

private String location

file

private String file

type

private String type

number

private String number

enabled

private boolean enabled

organizationDN

private String organizationDN

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

DEBUG

private static final boolean DEBUG

See Also:

Constant Field Values

Constructor Detail

NmDocument

public NmDocument()

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 NmWorkableObject

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 NmWorkableObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

Returns:

String

isHasContents

public boolean isHasContents()

Gets the value of the attribute: hasContents.

Supported API: false

Returns:

boolean

setHasContents

public void setHasContents(boolean a_HasContents)

Sets the value of the attribute: hasContents.

Supported API: false

Parameters:

a_HasContents -

isIsTemplate

public boolean isIsTemplate()

Gets the value of the attribute: isTemplate.

Supported API: false

Returns:

boolean

setIsTemplate

public void setIsTemplate(boolean a_IsTemplate)

Sets the value of the attribute: isTemplate.

Supported API: false

Parameters:

a_IsTemplate -

getLocation

public String getLocation()

Gets the value of the attribute: location.

Supported API: false

Returns:

String

setLocation

public void setLocation(String a_Location)

Sets the value of the attribute: location.

Supported API: false

Parameters:

a_Location -

getFile

public String getFile()

Gets the value of the attribute: file.

Supported API: false

Returns:

String

setFile

public void setFile(String a_File)

Sets the value of the attribute: file.

Supported API: false

Parameters:

a_File -

getType

public String getType()

Gets the value of the attribute: type.

Supported API: false

Returns:

String

setType

public void setType(String a_Type)

Sets the value of the attribute: type.

Supported API: false

Parameters:

a_Type -

getNumber

public String getNumber()

Gets the value of the attribute: number.

Supported API: false

Returns:

String

setNumber

public void setNumber(String a_Number)

Sets the value of the attribute: number.

Supported API: false

Parameters:

a_Number -

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 -

getOrganizationDN

public String getOrganizationDN()

Gets the value of the attribute: organizationDN.

Supported API: false

Returns:

String

setOrganizationDN

public void setOrganizationDN(String a_OrganizationDN)

Sets the value of the attribute: organizationDN.

Supported API: false

Parameters:

a_OrganizationDN -

newNmDocument

public static NmDocument newNmDocument()
                                throws WTException

Default factory for the class.

Supported API: false

Returns:

NmDocument

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 -

checkAvailable

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

Description copied from class: NmWorkableObject

Supported API: false

Specified by:

checkAvailable in interface NmActionTarget

Overrides:

checkAvailable in class NmWorkableObject

Parameters:

action -

container -

checkInfo -

Returns:

boolean