wt.fv
Class Vault

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

All Implemented Interfaces:

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

Direct Known Subclasses:

FvVault, ReplicaVault

public abstract class Vault

extends Simple

implements Storage, Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private boolean	enabled
static long	EXTERNALIZATION_VERSION_UID
static String	FOR_CACHED_ITEMS Label for the attribute; Vault to be used as Content Cache designated Vault if true.
static String	FOR_MASTERED_ITEMS Label for the attribute; Vault to be used as Content Cache designated Vault if true.
private boolean	forMasteredItems
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
(package private) static long	serialVersionUID
static String	SITE Label for the attribute.
static String	SITE_REFERENCE Label for the attribute.
private ObjectReference	siteReference

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fv.Storage

ENABLED

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

Vault()

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.
String	getIdentity() Supported API: false
String	getName() Gets the value of the attribute: NAME.
Site	getSite() Gets the object for the association that plays role: SITE.
ObjectReference	getSiteReference() Gets the value of the attribute: SITE_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
boolean	isEnabled() Gets the value of the attribute: ENABLED.
boolean	isForCachedItems() Gets the value of the attribute: FOR_CACHED_ITEMS.
boolean	isForMasteredItems() Gets the value of the attribute: FOR_MASTERED_ITEMS.
boolean	isReadOnly() Gets the value of the attribute: READ_ONLY.
boolean	isWriteEnabled()
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(Vault thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setEnabled(boolean a_Enabled) Sets the value of the attribute: ENABLED.
void	setForCachedItems(boolean a_ForCachedItems) Sets the value of the attribute: FOR_CACHED_ITEMS.
void	setForMasteredItems(boolean a_ForMasteredItems) Sets the value of the attribute: FOR_MASTERED_ITEMS.
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	setSite(Site a_Site) Sets the object for the association that plays role: SITE.
void	setSiteReference(ObjectReference a_SiteReference) Sets the value of the attribute: SITE_REFERENCE.
private void	siteReferenceValidate(ObjectReference a_SiteReference)
String	toString() If the object has been persisted, return it's ObjectIdentifier.
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, initialize, 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

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

READ_ONLY

public static final String READ_ONLY

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

readOnly

private boolean readOnly

FOR_MASTERED_ITEMS

public static final String FOR_MASTERED_ITEMS

Label for the attribute; Vault to be used as Content Cache designated Vault if true. Use isForCachedItems and setForCachedItems to access value of forMasteredItems.

Supported API: false

See Also:

Constant Field Values

forMasteredItems

private boolean forMasteredItems

FOR_CACHED_ITEMS

public static final String FOR_CACHED_ITEMS

Label for the attribute; Vault to be used as Content Cache designated Vault if true.

Supported API: false

See Also:

Constant Field Values

SITE

public static final String SITE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

SITE_REFERENCE

public static final String SITE_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

siteReference

private ObjectReference siteReference

enabled

private boolean enabled

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

Vault

public Vault()

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

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 -

isForMasteredItems

public boolean isForMasteredItems()

Gets the value of the attribute: FOR_MASTERED_ITEMS. Vault to be used as Content Cache designated Vault if true. Use isForCachedItems and setForCachedItems to access value of forMasteredItems.

Supported API: false

Returns:

boolean

setForMasteredItems

public void setForMasteredItems(boolean a_ForMasteredItems)
                         throws WTPropertyVetoException

Sets the value of the attribute: FOR_MASTERED_ITEMS. Vault to be used as Content Cache designated Vault if true. Use isForCachedItems and setForCachedItems to access value of forMasteredItems.

Supported API: false

Parameters:

a_ForMasteredItems -

Throws:

WTPropertyVetoException

isForCachedItems

public boolean isForCachedItems()

Gets the value of the attribute: FOR_CACHED_ITEMS. Vault to be used as Content Cache designated Vault if true.

Supported API: false

Returns:

boolean

setForCachedItems

public void setForCachedItems(boolean a_ForCachedItems)
                       throws WTPropertyVetoException

Sets the value of the attribute: FOR_CACHED_ITEMS. Vault to be used as Content Cache designated Vault if true.

Supported API: false

Parameters:

a_ForCachedItems -

Throws:

WTPropertyVetoException

getSite

public Site getSite()

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

Supported API: false

Returns:

Site

setSite

public void setSite(Site a_Site)
             throws WTPropertyVetoException,
                    WTException

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

Supported API: false

Parameters:

a_Site -

Throws:

WTPropertyVetoException

WTException

getSiteReference

public ObjectReference getSiteReference()

Gets the value of the attribute: SITE_REFERENCE.

Supported API: false

Returns:

ObjectReference

setSiteReference

public void setSiteReference(ObjectReference a_SiteReference)
                      throws WTPropertyVetoException

Sets the value of the attribute: SITE_REFERENCE.

Supported API: false

Parameters:

a_SiteReference -

Throws:

WTPropertyVetoException

siteReferenceValidate

private void siteReferenceValidate(ObjectReference a_SiteReference)
                            throws WTPropertyVetoException

Parameters:

a_SiteReference -

Throws:

WTPropertyVetoException

getIdentity

public String getIdentity()

Supported API: false

Specified by:

getIdentity in interface BusinessInformation

Overrides:

getIdentity in class Simple

Returns:

String

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

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)
                throws WTPropertyVetoException

Sets the value of the attribute: ENABLED.

Supported API: false

Specified by:

setEnabled in interface Storage

Parameters:

a_Enabled -

Throws:

WTPropertyVetoException

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

toString

public String toString()

Description copied from class: WTObject

If the object has been persisted, return it's ObjectIdentifier. If it has not yet been persisted, simply return it's conceptual (modeled) name.

Overrides:

toString in class WTObject

Returns:

String

isWriteEnabled

public boolean isWriteEnabled()