com.ptc.netmarkets.bookmark
Class NmBookmark

java.lang.Object
  com.ptc.netmarkets.model.NmObject
      com.ptc.netmarkets.model.NmNamedObject
          com.ptc.netmarkets.bookmark.NmBookmark

All Implemented Interfaces:

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

public class NmBookmark

extends NmNamedObject

implements NmDescribed, NmWorkable, Externalizable

Use the newNmBookmark static factory method(s), not the NmBookmark 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 boolean	availForRollupIterations
private String	bookmarkType
private boolean	checkedout
private NmUser	checkedOutBy
private boolean	checkedOutOwner
private static String	CHECKIN
private static String	CHECKOUT
private static String	CLASSNAME
private String	containerName
private String	description
static long	EXTERNALIZATION_VERSION_UID
private Timestamp	lastModified
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	TYPE Supported API: false
private String	typeId
private static String	UNDOCHECKOUT
private URL	url
private static boolean	VERBOSE

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

NmBookmark()

Method Summary

boolean	checkAvailable(NmAction actionName, WTContainer container, HashMap checkInfo) Supported API: false
String	getBookmarkType() Gets the value of the attribute: bookmarkType.
NmUser	getCheckedOutBy() Gets the value of the attribute: checkedOutBy.
String	getConceptualClassname() Deprecated.
String	getContainerName() Gets the value of the attribute: containerName.
String	getDescription() Gets the value of the attribute: description.
Timestamp	getLastModified() Gets the value of the attribute: lastModified.
String	getTypeId() Gets the value of the attribute: typeId.
URL	getUrl() Gets the value of the attribute: url.
boolean	isAvailForRollupIterations() Gets the value of the attribute: availForRollupIterations.
boolean	isCheckedout() Gets the value of the attribute: checkedout.
boolean	isCheckedOutOwner() Gets the value of the attribute: checkedOutOwner.
static NmBookmark	newNmBookmark() 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(NmBookmark thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAvailForRollupIterations(boolean a_AvailForRollupIterations) Sets the value of the attribute: availForRollupIterations.
void	setBookmarkType(String a_BookmarkType) Sets the value of the attribute: bookmarkType.
void	setCheckedout(boolean a_Checkedout) Sets the value of the attribute: checkedout.
void	setCheckedOutBy(NmUser a_CheckedOutBy) Sets the value of the attribute: checkedOutBy.
void	setCheckedOutOwner(boolean a_CheckedOutOwner) Sets the value of the attribute: checkedOutOwner.
void	setContainerName(String a_ContainerName) Sets the value of the attribute: containerName.
void	setDescription(String a_Description) Sets the value of the attribute: description.
void	setLastModified(Timestamp a_LastModified) Sets the value of the attribute: lastModified.
void	setTypeId(String a_TypeId) Sets the value of the attribute: typeId.
void	setUrl(URL a_Url) Sets the value of the attribute: url.
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, 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

url

private URL url

checkedOutOwner

private boolean checkedOutOwner

bookmarkType

private String bookmarkType

description

private String description

checkedout

private boolean checkedout

availForRollupIterations

private boolean availForRollupIterations

lastModified

private Timestamp lastModified

checkedOutBy

private NmUser checkedOutBy

containerName

private String containerName

typeId

private String typeId

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

VERBOSE

private static final boolean VERBOSE

CHECKOUT

private static final String CHECKOUT

See Also:

Constant Field Values

CHECKIN

private static final String CHECKIN

See Also:

Constant Field Values

UNDOCHECKOUT

private static final String UNDOCHECKOUT

See Also:

Constant Field Values

Constructor Detail

NmBookmark

public NmBookmark()

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

getUrl

public URL getUrl()

Gets the value of the attribute: url.

Supported API: false

Returns:

URL

setUrl

public void setUrl(URL a_Url)
            throws WTPropertyVetoException

Sets the value of the attribute: url.

Supported API: false

Parameters:

a_Url -

Throws:

WTPropertyVetoException

isCheckedOutOwner

public boolean isCheckedOutOwner()

Gets the value of the attribute: checkedOutOwner.

Supported API: false

Specified by:

isCheckedOutOwner in interface NmWorkable

Returns:

boolean

setCheckedOutOwner

public void setCheckedOutOwner(boolean a_CheckedOutOwner)

Sets the value of the attribute: checkedOutOwner.

Supported API: false

Specified by:

setCheckedOutOwner in interface NmWorkable

Parameters:

a_CheckedOutOwner -

getBookmarkType

public String getBookmarkType()

Gets the value of the attribute: bookmarkType.

Supported API: false

Returns:

String

setBookmarkType

public void setBookmarkType(String a_BookmarkType)

Sets the value of the attribute: bookmarkType.

Supported API: false

Parameters:

a_BookmarkType -

newNmBookmark

public static NmBookmark newNmBookmark()
                                throws WTException

Default factory for the class.

Supported API: false

Returns:

NmBookmark

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 -

isCheckedout

public boolean isCheckedout()

Gets the value of the attribute: checkedout.

Supported API: false

Specified by:

isCheckedout in interface NmWorkable

Returns:

boolean

setCheckedout

public void setCheckedout(boolean a_Checkedout)

Sets the value of the attribute: checkedout.

Supported API: false

Specified by:

setCheckedout in interface NmWorkable

Parameters:

a_Checkedout -

isAvailForRollupIterations

public boolean isAvailForRollupIterations()

Gets the value of the attribute: availForRollupIterations.

Supported API: false

Specified by:

isAvailForRollupIterations in interface NmWorkable

Returns:

boolean

setAvailForRollupIterations

public void setAvailForRollupIterations(boolean a_AvailForRollupIterations)

Sets the value of the attribute: availForRollupIterations.

Supported API: false

Specified by:

setAvailForRollupIterations in interface NmWorkable

Parameters:

a_AvailForRollupIterations -

getLastModified

public Timestamp getLastModified()

Gets the value of the attribute: lastModified.

Supported API: false

Specified by:

getLastModified in interface NmWorkable

Returns:

Timestamp

setLastModified

public void setLastModified(Timestamp a_LastModified)

Sets the value of the attribute: lastModified.

Supported API: false

Specified by:

setLastModified in interface NmWorkable

Parameters:

a_LastModified -

getCheckedOutBy

public NmUser getCheckedOutBy()

Gets the value of the attribute: checkedOutBy.

Supported API: false

Specified by:

getCheckedOutBy in interface NmWorkable

Returns:

NmUser

setCheckedOutBy

public void setCheckedOutBy(NmUser a_CheckedOutBy)

Sets the value of the attribute: checkedOutBy.

Supported API: false

Specified by:

setCheckedOutBy in interface NmWorkable

Parameters:

a_CheckedOutBy -

getContainerName

public String getContainerName()

Gets the value of the attribute: containerName.

Supported API: false

Specified by:

getContainerName in interface NmWorkable

Returns:

String

setContainerName

public void setContainerName(String a_ContainerName)

Sets the value of the attribute: containerName.

Supported API: false

Specified by:

setContainerName in interface NmWorkable

Parameters:

a_ContainerName -

getTypeId

public String getTypeId()

Gets the value of the attribute: typeId.

Supported API: false

Specified by:

getTypeId in interface NmWorkable

Returns:

String

setTypeId

public void setTypeId(String a_TypeId)

Sets the value of the attribute: typeId.

Supported API: false

Specified by:

setTypeId in interface NmWorkable

Parameters:

a_TypeId -

checkAvailable

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

Description copied from class: NmObject

Supported API: false

Specified by:

checkAvailable in interface NmActionTarget

Overrides:

checkAvailable in class NmObject

Parameters:

actionName -

container -

checkInfo -

Returns:

boolean