wt.epm.workspaces
Class ClientCacheState

java.lang.Object
  wt.epm.workspaces.ClientCacheState

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class ClientCacheState

extends Object

implements Persistable, Externalizable

State of EPMDocument's CAD files in the local client cache associated with an EPMWorkspace. For example, ClientCacheState records whether the CAD files have been downloaded to or locally modified in the client cache.

Use the newClientCacheState static factory method(s), not the ClientCacheState 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 String	DOCUMENT Label for the attribute.
static String	DOCUMENT_REFERENCE Label for the attribute.
private ObjectReference	documentReference
private boolean	downloaded
static String	DOWNLOADED Label for the attribute; Specifies whether or not the CAD file for the document has been downloaded to the active client cache.
static long	EXTERNALIZATION_VERSION_UID
static String	LOCALLY_MODIFIED Label for the attribute; Specifies whether the CAD file for the document has been modified locally in the active client cache.
private boolean	locallyModified
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo
static String	WORKSPACE Label for the attribute.
static String	WORKSPACE_REFERENCE Label for the attribute.
private ObjectReference	workspaceReference

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

ClientCacheState()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	documentReferenceValidate(ObjectReference a_DocumentReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
EPMDocument	getDocument() Gets the object for the association that plays role: DOCUMENT.
ObjectReference	getDocumentReference() Gets the value of the attribute: DOCUMENT_REFERENCE.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
EPMWorkspace	getWorkspace() Gets the object for the association that plays role: WORKSPACE.
ObjectReference	getWorkspaceReference() Gets the value of the attribute: WORKSPACE_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(EPMWorkspace workspace, EPMDocument document, boolean downloaded, boolean locallyModified) Supports initialization, following construction of an instance.
boolean	isDownloaded() Gets the value of the attribute: DOWNLOADED.
boolean	isLocallyModified() Gets the value of the attribute: LOCALLY_MODIFIED.
static ClientCacheState	newClientCacheState(EPMWorkspace workspace, EPMDocument document, boolean downloaded, boolean locallyModified) 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(ClientCacheState thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDocument(EPMDocument a_Document) Sets the object for the association that plays role: DOCUMENT.
void	setDocumentReference(ObjectReference a_DocumentReference) Sets the value of the attribute: DOCUMENT_REFERENCE.
void	setDownloaded(boolean a_Downloaded) Sets the value of the attribute: DOWNLOADED.
void	setLocallyModified(boolean a_LocallyModified) Sets the value of the attribute: LOCALLY_MODIFIED.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setWorkspace(EPMWorkspace a_Workspace) Sets the object for the association that plays role: WORKSPACE.
void	setWorkspaceReference(ObjectReference a_WorkspaceReference) Sets the value of the attribute: WORKSPACE_REFERENCE.
String	toString() Returns the conceptual (modeled) name for the class.
private void	workspaceReferenceValidate(ObjectReference a_WorkspaceReference)
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 java.lang.Object

clone, finalize, 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

DOWNLOADED

public static final String DOWNLOADED

Label for the attribute; Specifies whether or not the CAD file for the document has been downloaded to the active client cache.

Supported API: false

See Also:

Constant Field Values

downloaded

private boolean downloaded

LOCALLY_MODIFIED

public static final String LOCALLY_MODIFIED

Label for the attribute; Specifies whether the CAD file for the document has been modified locally in the active client cache.

Supported API: false

See Also:

Constant Field Values

locallyModified

private boolean locallyModified

WORKSPACE

public static final String WORKSPACE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

WORKSPACE_REFERENCE

public static final String WORKSPACE_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

workspaceReference

private ObjectReference workspaceReference

DOCUMENT

public static final String DOCUMENT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DOCUMENT_REFERENCE

public static final String DOCUMENT_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

documentReference

private ObjectReference documentReference

thePersistInfo

private PersistInfo thePersistInfo

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

ClientCacheState

public ClientCacheState()

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

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

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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

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

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

isDownloaded

public boolean isDownloaded()

Gets the value of the attribute: DOWNLOADED. Specifies whether or not the CAD file for the document has been downloaded to the active client cache.

Supported API: false

Returns:

boolean

setDownloaded

public void setDownloaded(boolean a_Downloaded)
                   throws WTPropertyVetoException

Sets the value of the attribute: DOWNLOADED. Specifies whether or not the CAD file for the document has been downloaded to the active client cache.

Supported API: false

Parameters:

a_Downloaded -

Throws:

WTPropertyVetoException

isLocallyModified

public boolean isLocallyModified()

Gets the value of the attribute: LOCALLY_MODIFIED. Specifies whether the CAD file for the document has been modified locally in the active client cache.

Supported API: false

Returns:

boolean

setLocallyModified

public void setLocallyModified(boolean a_LocallyModified)
                        throws WTPropertyVetoException

Sets the value of the attribute: LOCALLY_MODIFIED. Specifies whether the CAD file for the document has been modified locally in the active client cache.

Supported API: false

Parameters:

a_LocallyModified -

Throws:

WTPropertyVetoException

getWorkspace

public EPMWorkspace getWorkspace()

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

Supported API: false

Returns:

EPMWorkspace

setWorkspace

public void setWorkspace(EPMWorkspace a_Workspace)
                  throws WTPropertyVetoException,
                         WTException

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

Supported API: false

Parameters:

a_Workspace -

Throws:

WTPropertyVetoException

WTException

getWorkspaceReference

public ObjectReference getWorkspaceReference()

Gets the value of the attribute: WORKSPACE_REFERENCE.

Supported API: false

Returns:

ObjectReference

setWorkspaceReference

public void setWorkspaceReference(ObjectReference a_WorkspaceReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: WORKSPACE_REFERENCE.

Supported API: false

Parameters:

a_WorkspaceReference -

Throws:

WTPropertyVetoException

workspaceReferenceValidate

private void workspaceReferenceValidate(ObjectReference a_WorkspaceReference)
                                 throws WTPropertyVetoException

Parameters:

a_WorkspaceReference -

Throws:

WTPropertyVetoException

getDocument

public EPMDocument getDocument()

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

Supported API: false

Returns:

EPMDocument

setDocument

public void setDocument(EPMDocument a_Document)
                 throws WTPropertyVetoException,
                        WTException

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

Supported API: false

Parameters:

a_Document -

Throws:

WTPropertyVetoException

WTException

getDocumentReference

public ObjectReference getDocumentReference()

Gets the value of the attribute: DOCUMENT_REFERENCE.

Supported API: false

Returns:

ObjectReference

setDocumentReference

public void setDocumentReference(ObjectReference a_DocumentReference)
                          throws WTPropertyVetoException

Sets the value of the attribute: DOCUMENT_REFERENCE.

Supported API: false

Parameters:

a_DocumentReference -

Throws:

WTPropertyVetoException

documentReferenceValidate

private void documentReferenceValidate(ObjectReference a_DocumentReference)
                                throws WTPropertyVetoException

Parameters:

a_DocumentReference -

Throws:

WTPropertyVetoException

newClientCacheState

public static ClientCacheState newClientCacheState(EPMWorkspace workspace,
                                                   EPMDocument document,
                                                   boolean downloaded,
                                                   boolean locallyModified)
                                            throws WTException

Supported API: false

Parameters:

workspace -

document -

downloaded -

locallyModified -

Returns:

ClientCacheState

Throws:

WTException

initialize

protected void initialize(EPMWorkspace workspace,
                          EPMDocument document,
                          boolean downloaded,
                          boolean locallyModified)
                   throws WTException

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

Supported API: false

Parameters:

workspace -

document -

downloaded -

locallyModified -

Throws:

WTException

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

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

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

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

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

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

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

Returns:

int