wt.fv.master
Class MasteredOnReplicaItem

java.lang.Object
  wt.fc.WTObject
      wt.fv.StoredItem
          wt.fv.master.MasteredOnReplicaItem

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Revaultable, Serializable, Streamed, UniquelyIdentifiedContent

public class MasteredOnReplicaItem

extends StoredItem

implements Streamed, Externalizable

Use the newMasteredOnReplicaItem static factory method(s), not the MasteredOnReplicaItem 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
private long	fileSize
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
private long	revaultSessionId
(package private) static long	serialVersionUID
private long	streamId
static String	UPLOAD_IN_PROGRESS Label for the attribute.
private boolean	uploadInProgress

Fields inherited from class wt.fv.StoredItem

FOLDER, FOLDER_REFERENCE, UNIQUE_SEQUENCE_NUMBER

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.content.Streamed

FILE_SIZE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.fv.Revaultable

INITIAL_VALUE, REVAULT_SESSION_ID

Fields inherited from interface wt.fv.UniquelyIdentifiedContent

STREAM_ID

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

MasteredOnReplicaItem()

Method Summary

protected ReplicatedItem	createsReplicatedItemFootprint() Creates a corresponding Replicated to this Master on Replica item. Intent is to provide a "track" of previously existing files on Replica, for future file purging mechanism.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
private ContentHolder	getContentHolderForStreamed()
long	getFileSize() Gets the value of the attribute: FILE_SIZE.
long	getRevaultSessionId() Gets the value of the attribute: REVAULT_SESSION_ID.
private QueryResult	getStreamedObjAppDatas()
long	getStreamId() Gets the value of the attribute: STREAM_ID.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
boolean	isUploadInProgress() Gets the value of the attribute: UPLOAD_IN_PROGRESS.
static MasteredOnReplicaItem	newMasteredOnReplicaItem() Default factory for the class.
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(MasteredOnReplicaItem thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	removeStream() Supported API: false
InputStream	retrieveStream() Supported API: false
void	setFileSize(long a_FileSize) Sets the value of the attribute: FILE_SIZE.
void	setRevaultSessionId(long a_RevaultSessionId) Sets the value of the attribute: REVAULT_SESSION_ID.
void	setStreamId(long a_StreamId) Sets the value of the attribute: STREAM_ID.
void	setUploadInProgress(boolean a_UploadInProgress) Sets the value of the attribute: UPLOAD_IN_PROGRESS.
Streamed	storeStream(ContentHolder holder, ApplicationData appData, InputStream is) Supported API: false
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.fv.StoredItem

buildFileName, getFolder, getFolderReference, getName, getUniqueSequenceNumber, readVersion, setFolder, setFolderReference, setUniqueSequenceNumber

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

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

UPLOAD_IN_PROGRESS

public static final String UPLOAD_IN_PROGRESS

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

uploadInProgress

private boolean uploadInProgress

fileSize

private long fileSize

revaultSessionId

private long revaultSessionId

streamId

private long streamId

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

MasteredOnReplicaItem

public MasteredOnReplicaItem()

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 StoredItem

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 StoredItem

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 StoredItem

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

isUploadInProgress

public boolean isUploadInProgress()

Gets the value of the attribute: UPLOAD_IN_PROGRESS.

Supported API: false

Returns:

boolean

setUploadInProgress

public void setUploadInProgress(boolean a_UploadInProgress)
                         throws WTPropertyVetoException

Sets the value of the attribute: UPLOAD_IN_PROGRESS.

Supported API: false

Parameters:

a_UploadInProgress -

Throws:

WTPropertyVetoException

newMasteredOnReplicaItem

public static MasteredOnReplicaItem newMasteredOnReplicaItem()
                                                      throws WTException

Default factory for the class.

Supported API: false

Returns:

MasteredOnReplicaItem

Throws:

WTException

getFileSize

public long getFileSize()

Gets the value of the attribute: FILE_SIZE.

Supported API: false

Specified by:

getFileSize in interface Streamed

Returns:

long

setFileSize

public void setFileSize(long a_FileSize)

Sets the value of the attribute: FILE_SIZE.

Supported API: false

Specified by:

setFileSize in interface Streamed

Parameters:

a_FileSize -

storeStream

public Streamed storeStream(ContentHolder holder,
                            ApplicationData appData,
                            InputStream is)
                     throws WTException

Supported API: false

Specified by:

storeStream in interface Streamed

Parameters:

holder -

appData -

is -

Returns:

Streamed

Throws:

WTException

retrieveStream

public InputStream retrieveStream()
                           throws WTException

Supported API: false

Specified by:

retrieveStream in interface Streamed

Returns:

InputStream

Throws:

WTException

removeStream

public void removeStream()
                  throws WTException

Supported API: false

Specified by:

removeStream in interface Streamed

Throws:

WTException

getRevaultSessionId

public long getRevaultSessionId()

Gets the value of the attribute: REVAULT_SESSION_ID.

Supported API: false

Specified by:

getRevaultSessionId in interface Revaultable

Returns:

long

setRevaultSessionId

public void setRevaultSessionId(long a_RevaultSessionId)

Sets the value of the attribute: REVAULT_SESSION_ID.

Supported API: false

Specified by:

setRevaultSessionId in interface Revaultable

Parameters:

a_RevaultSessionId -

getStreamId

public long getStreamId()

Gets the value of the attribute: STREAM_ID.

Supported API: false

Specified by:

getStreamId in interface UniquelyIdentifiedContent

Returns:

long

setStreamId

public void setStreamId(long a_StreamId)

Sets the value of the attribute: STREAM_ID.

Supported API: false

Specified by:

setStreamId in interface UniquelyIdentifiedContent

Parameters:

a_StreamId -

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 StoredItem

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 StoredItem

Returns:

int

getContentHolderForStreamed

private ContentHolder getContentHolderForStreamed()
                                           throws WTException

Throws:

WTException

getStreamedObjAppDatas

private QueryResult getStreamedObjAppDatas()
                                    throws WTException

Throws:

WTException

createsReplicatedItemFootprint

protected ReplicatedItem createsReplicatedItemFootprint()

Creates a corresponding Replicated to this Master on Replica item.
Intent is to provide a "track" of previously existing files on Replica, for future file purging mechanism.

Returns:

the converted replicated item

Since:

Windchill R6 - build 39