wt.workflow.forum
Class ForumCookie

java.lang.Object
  wt.fc.WTObject
      wt.workflow.forum.ForumCookie

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class ForumCookie

extends WTObject

implements Externalizable

A ForumCookie contains information on all the postings read by a given user for a given Forum. It also carries a Timestamp of the last time the user accessed the forum.

Use the newForumCookie static factory method(s), not the ForumCookie 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
static String	FORUM Label for the attribute.
static String	FORUM_REFERENCE Label for the attribute.
private ObjectReference	forumReference
static String	LAST_READ Label for the attribute; The last time the user accessed the forum.
private Timestamp	lastRead
protected static long	OLD_FORMAT_VERSION_UID
static String	READ_POSTINGS Label for the attribute; The list of postings that have been read by the user.
private Vector	readPostings
private static String	RESOURCE
(package private) static long	serialVersionUID
private WTPrincipalReference	user
static String	USER Label for the attribute; The user that this cookie pertains to.

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

ForumCookie()

Method Summary

boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private void	forumReferenceValidate(ObjectReference a_ForumReference)
String	getConceptualClassname() Deprecated.
DiscussionForum	getForum() Gets the object for the association that plays role: FORUM.
ObjectReference	getForumReference() Gets the value of the attribute: FORUM_REFERENCE.
Timestamp	getLastRead() Gets the value of the attribute: LAST_READ.
Vector	getReadPostings() Gets the value of the attribute: READ_POSTINGS.
WTPrincipalReference	getUser() Gets the value of the attribute: USER.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(WTPrincipalReference user, Vector postings, Timestamp lastRead) Supports initialization, following construction of an instance.
protected void	initialize(WTPrincipalReference user, Vector postings, Timestamp lastRead, DiscussionForum forum) Supports initialization, following construction of an instance.
private void	lastReadValidate(Timestamp a_LastRead)
protected void	markPostingsRead(Vector readPostings, Timestamp lastRead) Marks the given postings as read by the user and sets lastRead to the given TimeStamp.
static ForumCookie	newForumCookie(WTPrincipalReference user, Vector postings, Timestamp lastRead) Supported API: false
static ForumCookie	newForumCookie(WTPrincipalReference user, Vector postings, Timestamp lastRead, DiscussionForum forum) Supported API: false
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
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(ForumCookie thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setForum(DiscussionForum a_Forum) Sets the object for the association that plays role: FORUM.
void	setForumReference(ObjectReference a_ForumReference) Sets the value of the attribute: FORUM_REFERENCE.
void	setLastRead(Timestamp a_LastRead) Sets the value of the attribute: LAST_READ.
void	setReadPostings(Vector a_ReadPostings) Sets the value of the attribute: READ_POSTINGS.
void	setUser(WTPrincipalReference a_User) Sets the value of the attribute: USER.
private void	userValidate(WTPrincipalReference a_User)
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

USER

public static final String USER

Label for the attribute; The user that this cookie pertains to.

Supported API: false

See Also:

Constant Field Values

user

private WTPrincipalReference user

READ_POSTINGS

public static final String READ_POSTINGS

Label for the attribute; The list of postings that have been read by the user.

Supported API: false

See Also:

Constant Field Values

readPostings

private Vector readPostings

LAST_READ

public static final String LAST_READ

Label for the attribute; The last time the user accessed the forum.

Supported API: false

See Also:

Constant Field Values

lastRead

private Timestamp lastRead

FORUM

public static final String FORUM

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

FORUM_REFERENCE

public static final String FORUM_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

forumReference

private ObjectReference forumReference

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

ForumCookie

public ForumCookie()

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 WTObject

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 WTObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class WTObject

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class WTObject

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getUser

public WTPrincipalReference getUser()

Gets the value of the attribute: USER. The user that this cookie pertains to.

Supported API: false

Returns:

WTPrincipalReference

setUser

public void setUser(WTPrincipalReference a_User)
             throws WTPropertyVetoException

Sets the value of the attribute: USER. The user that this cookie pertains to.

Supported API: false

Parameters:

a_User -

Throws:

WTPropertyVetoException

userValidate

private void userValidate(WTPrincipalReference a_User)
                   throws WTPropertyVetoException

Parameters:

a_User -

Throws:

WTPropertyVetoException

getReadPostings

public Vector getReadPostings()

Gets the value of the attribute: READ_POSTINGS. The list of postings that have been read by the user.

Supported API: false

Returns:

Vector

setReadPostings

public void setReadPostings(Vector a_ReadPostings)
                     throws WTPropertyVetoException

Sets the value of the attribute: READ_POSTINGS. The list of postings that have been read by the user.

Supported API: false

Parameters:

a_ReadPostings -

Throws:

WTPropertyVetoException

getLastRead

public Timestamp getLastRead()

Gets the value of the attribute: LAST_READ. The last time the user accessed the forum.

Supported API: false

Returns:

Timestamp

setLastRead

public void setLastRead(Timestamp a_LastRead)
                 throws WTPropertyVetoException

Sets the value of the attribute: LAST_READ. The last time the user accessed the forum.

Supported API: false

Parameters:

a_LastRead -

Throws:

WTPropertyVetoException

lastReadValidate

private void lastReadValidate(Timestamp a_LastRead)
                       throws WTPropertyVetoException

Parameters:

a_LastRead -

Throws:

WTPropertyVetoException

getForum

public DiscussionForum getForum()

Gets the object for the association that plays role: FORUM.

Supported API: false

Returns:

DiscussionForum

setForum

public void setForum(DiscussionForum a_Forum)
              throws WTPropertyVetoException,
                     WTException

Sets the object for the association that plays role: FORUM.

Supported API: false

Parameters:

a_Forum -

Throws:

WTPropertyVetoException

WTException

getForumReference

public ObjectReference getForumReference()

Gets the value of the attribute: FORUM_REFERENCE.

Supported API: false

Returns:

ObjectReference

setForumReference

public void setForumReference(ObjectReference a_ForumReference)
                       throws WTPropertyVetoException

Sets the value of the attribute: FORUM_REFERENCE.

Supported API: false

Parameters:

a_ForumReference -

Throws:

WTPropertyVetoException

forumReferenceValidate

private void forumReferenceValidate(ObjectReference a_ForumReference)
                             throws WTPropertyVetoException

Parameters:

a_ForumReference -

Throws:

WTPropertyVetoException

newForumCookie

public static ForumCookie newForumCookie(WTPrincipalReference user,
                                         Vector postings,
                                         Timestamp lastRead)
                                  throws WTException

Supported API: false

Parameters:

user -

postings -

lastRead -

Returns:

ForumCookie

Throws:

WTException

initialize

protected void initialize(WTPrincipalReference user,
                          Vector postings,
                          Timestamp lastRead)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

user -

postings -

lastRead -

Throws:

WTException

newForumCookie

public static ForumCookie newForumCookie(WTPrincipalReference user,
                                         Vector postings,
                                         Timestamp lastRead,
                                         DiscussionForum forum)
                                  throws WTException

Supported API: false

Parameters:

user -

postings -

lastRead -

forum -

Returns:

ForumCookie

Throws:

WTException

initialize

protected void initialize(WTPrincipalReference user,
                          Vector postings,
                          Timestamp lastRead,
                          DiscussionForum forum)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

user -

postings -

lastRead -

forum -

Throws:

WTException

markPostingsRead

protected void markPostingsRead(Vector readPostings,
                                Timestamp lastRead)
                         throws WTException

Marks the given postings as read by the user and sets lastRead to the given TimeStamp.

Supported API: false

Parameters:

readPostings -

lastRead -

Throws:

WTException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class WTObject

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class WTObject

Returns:

int