wt.fv
Class FileFolder

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.fv.FileFolder

All Implemented Interfaces:

AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Persistable, Serializable, Storage

Direct Known Subclasses:

FvFolder, ReplicaFolder

public abstract class FileFolder

extends Simple

implements Storage, Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private long	capacity
static String	CAPACITY Label for the attribute.
private static String	CLASSNAME
private boolean	enabled
static String	ENABLED Label for the attribute.
static long	EXTERNALIZATION_VERSION_UID
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
static String	READ_ONLY Label for the attribute.
private boolean	readOnly
private static String	RESOURCE
static String	SEQ_NUMBER Label for the attribute.
private int	seqNumber
(package private) static long	serialVersionUID
private long	threshold
static String	THRESHOLD Label for the attribute.
static String	VAULT Label for the attribute.
static String	VAULT_REFERENCE Label for the attribute.
private ObjectReference	vaultReference

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

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

FileFolder()

Method Summary

abstract void	delete() Supported API: false
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
long	getCapacity() Gets the value of the attribute: CAPACITY.
String	getIdentity() Supported API: false
String	getName() Gets the value of the attribute: NAME.
int	getSeqNumber() Gets the value of the attribute: SEQ_NUMBER.
long	getThreshold() Gets the value of the attribute: THRESHOLD.
Vault	getVault() Gets the object for the association that plays role: VAULT.
ObjectReference	getVaultReference() Gets the value of the attribute: VAULT_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supported API: false
boolean	isEnabled() Gets the value of the attribute: ENABLED.
boolean	isReadOnly() Gets the value of the attribute: READ_ONLY.
private void	nameValidate(String a_Name)
abstract void	purge() 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(FileFolder thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCapacity(long a_Capacity) Sets the value of the attribute: CAPACITY.
void	setEnabled(boolean a_Enabled) Sets the value of the attribute: ENABLED.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setReadOnly(boolean a_ReadOnly) Sets the value of the attribute: READ_ONLY.
void	setSeqNumber(int a_SeqNumber) Sets the value of the attribute: SEQ_NUMBER.
void	setThreshold(long a_Threshold) Sets the value of the attribute: THRESHOLD.
void	setVault(Vault a_Vault) Sets the object for the association that plays role: VAULT.
void	setVaultReference(ObjectReference a_VaultReference) Sets the value of the attribute: VAULT_REFERENCE.
private void	vaultReferenceValidate(ObjectReference a_VaultReference)
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.enterprise.Simple

getBusinessType, getDomainRef, getEventSet, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain

Methods inherited from class wt.fc.WTObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

NAME

public static final String NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

ENABLED

public static final String ENABLED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

enabled

private boolean enabled

READ_ONLY

public static final String READ_ONLY

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

readOnly

private boolean readOnly

SEQ_NUMBER

public static final String SEQ_NUMBER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

seqNumber

private int seqNumber

CAPACITY

public static final String CAPACITY

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

capacity

private long capacity

THRESHOLD

public static final String THRESHOLD

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

threshold

private long threshold

VAULT

public static final String VAULT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

VAULT_REFERENCE

public static final String VAULT_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

vaultReference

private ObjectReference vaultReference

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

FileFolder

public FileFolder()

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 Simple

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 Simple

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 Simple

Parameters:

input -

Throws:

SQLException

DatastoreException

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

isEnabled

public boolean isEnabled()

Gets the value of the attribute: ENABLED.

Supported API: false

Specified by:

isEnabled in interface Storage

Returns:

boolean

setEnabled

public void setEnabled(boolean a_Enabled)

Sets the value of the attribute: ENABLED.

Supported API: false

Specified by:

setEnabled in interface Storage

Parameters:

a_Enabled -

isReadOnly

public boolean isReadOnly()

Gets the value of the attribute: READ_ONLY.

Supported API: false

Returns:

boolean

setReadOnly

public void setReadOnly(boolean a_ReadOnly)

Sets the value of the attribute: READ_ONLY.

Supported API: false

Parameters:

a_ReadOnly -

getSeqNumber

public int getSeqNumber()

Gets the value of the attribute: SEQ_NUMBER.

Supported API: false

Returns:

int

setSeqNumber

public void setSeqNumber(int a_SeqNumber)

Sets the value of the attribute: SEQ_NUMBER.

Supported API: false

Parameters:

a_SeqNumber -

getCapacity

public long getCapacity()

Gets the value of the attribute: CAPACITY.

Supported API: false

Returns:

long

setCapacity

public void setCapacity(long a_Capacity)

Sets the value of the attribute: CAPACITY.

Supported API: false

Parameters:

a_Capacity -

getThreshold

public long getThreshold()

Gets the value of the attribute: THRESHOLD.

Supported API: false

Returns:

long

setThreshold

public void setThreshold(long a_Threshold)

Sets the value of the attribute: THRESHOLD.

Supported API: false

Parameters:

a_Threshold -

getVault

public Vault getVault()

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

Supported API: false

Returns:

Vault

setVault

public void setVault(Vault a_Vault)
              throws WTPropertyVetoException,
                     WTException

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

Supported API: false

Parameters:

a_Vault -

Throws:

WTPropertyVetoException

WTException

getVaultReference

public ObjectReference getVaultReference()

Gets the value of the attribute: VAULT_REFERENCE.

Supported API: false

Returns:

ObjectReference

setVaultReference

public void setVaultReference(ObjectReference a_VaultReference)
                       throws WTPropertyVetoException

Sets the value of the attribute: VAULT_REFERENCE.

Supported API: false

Parameters:

a_VaultReference -

Throws:

WTPropertyVetoException

vaultReferenceValidate

private void vaultReferenceValidate(ObjectReference a_VaultReference)
                             throws WTPropertyVetoException

Parameters:

a_VaultReference -

Throws:

WTPropertyVetoException

getIdentity

public String getIdentity()

Supported API: false

Specified by:

getIdentity in interface BusinessInformation

Overrides:

getIdentity in class Simple

Returns:

String

initialize

protected void initialize()
                   throws WTException

Supported API: false

Overrides:

initialize in class Simple

Throws:

WTException

purge

public abstract void purge()
                    throws WTException

Supported API: false

Specified by:

purge in interface Storage

Throws:

WTException

delete

public abstract void delete()
                     throws WTException

Supported API: false

Specified by:

delete in interface Storage

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 Simple

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 Simple

Returns:

int