wt.enterprise
Class FolderResident

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.FolderResident

All Implemented Interfaces:

AccessControlled, BusinessInformation, CabinetBased, DisplayIdentification, DomainAdministered, Externalizable, Foldered, FolderEntry, FolderServiceManaged, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, Serializable

Direct Known Subclasses:

ReportTemplate, WTRNRequest

public abstract class FolderResident

extends WTObject

implements Foldered, AccessControlled, DomainAdministered, Ownable, BusinessInformation, Notifiable, Externalizable

This first class information object is Foldered for organizational purposes and DomainAdministered, but is not LifeCycleManaged; it is a non-revisable object that the system manages and controls via business rules, notifications, access control, indexing, etc.

Objects of this class are not subject to life cycle management. By being accessible in folders, they are more visible to users. Since they are not life cycle managed (have no life cycle state), they are still more administrative in nature.

Supported API: true

Extendable: true

See Also:

"'The Enterprise Layer' in 'Application Developer's Guide'", "'folder package -- Folder service' in "'Application Developer's Guide'", "'admin package -- Domain Administration service' in "'Application Developer's Guide'", Serialized Form

Field Summary

private static String	CLASSNAME
private WTPrincipalReference	creator
static String	CREATOR Label for the attribute; The reference to a persisted principal who created the object.
static String	CREATOR_EMAIL Label for the attribute; Derived attribute for displaying the creator E-Mail value in query results.
static String	CREATOR_FULL_NAME Label for the attribute; Derived attribute for displaying the creator fullname value in query results.
static String	CREATOR_NAME Label for the attribute; Derived attribute for displaying the creator name value in query results.
private AdminDomainRef	domainRef
private WTStringSet	eventSet
static long	EXTERNALIZATION_VERSION_UID
private FolderingInfo	folderingInfo
private boolean	inheritedDomain
protected static long	OLD_FORMAT_VERSION_UID
private Ownership	ownership
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.folder.Foldered

CABINET, CABINET_NAME, FOLDERING_INFO

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION, NAME

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

FolderResident()

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.
String	getBusinessType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getBusinessType(). Another alternative is ((WTObject)obj).getDisplayType().
CabinetReference	getCabinet() Gets the value of the attribute: CABINET.
String	getCabinetName() Gets the value of the attribute: CABINET_NAME.
CabinetReference	getCabinetReference() Gets the value of the attribute: CABINET_REFERENCE.
WTPrincipalReference	getCreator() Gets the object for the association that plays role: CREATOR.
String	getCreatorEMail() Gets the value of the attribute: CREATOR_EMAIL.
String	getCreatorFullName() Gets the value of the attribute: CREATOR_FULL_NAME.
String	getCreatorName() Gets the value of the attribute: CREATOR_NAME.
AdminDomainRef	getDomainRef() Gets the object for the association that plays role: DOMAIN_REF.
WTStringSet	getEventSet() Gets the value of the attribute: EVENT_SET.
FolderingInfo	getFolderingInfo() Gets the object for the association that plays role: FOLDERING_INFO.
String	getFolderPath() Gets the value of the attribute: FOLDER_PATH.
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()
String	getLocation() Gets the value of the attribute: LOCATION.
String	getName() Supported API: false
Ownership	getOwnership() Gets the object for the association that plays role: OWNERSHIP.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Initializes objects created by new-factory methods.
boolean	isInheritedDomain() Gets the value of the attribute: INHERITED_DOMAIN.
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(FolderResident thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDomainRef(AdminDomainRef a_DomainRef) Sets the object for the association that plays role: DOMAIN_REF.
void	setEventSet(WTStringSet a_EventSet) Sets the value of the attribute: EVENT_SET.
void	setFolderingInfo(FolderingInfo a_FolderingInfo) Sets the object for the association that plays role: FOLDERING_INFO.
void	setInheritedDomain(boolean a_InheritedDomain) Sets the value of the attribute: INHERITED_DOMAIN.
void	setOwnership(Ownership a_Ownership) Sets the object for the association that plays role: OWNERSHIP.
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, 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.Persistable

checkAttributes, getPersistInfo, getType, setPersistInfo

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

CREATOR_EMAIL

public static final String CREATOR_EMAIL

Label for the attribute; Derived attribute for displaying the creator E-Mail value in query results.

Supported API: false

See Also:

Constant Field Values

CREATOR_NAME

public static final String CREATOR_NAME

Label for the attribute; Derived attribute for displaying the creator name value in query results.

Supported API: false

See Also:

Constant Field Values

CREATOR_FULL_NAME

public static final String CREATOR_FULL_NAME

Label for the attribute; Derived attribute for displaying the creator fullname value in query results.

Supported API: false

See Also:

Constant Field Values

CREATOR

public static final String CREATOR

Label for the attribute; The reference to a persisted principal who created the object.

Supported API: false

See Also:

Constant Field Values

creator

private WTPrincipalReference creator

folderingInfo

private FolderingInfo folderingInfo

inheritedDomain

private boolean inheritedDomain

domainRef

private AdminDomainRef domainRef

ownership

private Ownership ownership

eventSet

private WTStringSet eventSet

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

FolderResident

public FolderResident()

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

getCreatorEMail

public String getCreatorEMail()

Gets the value of the attribute: CREATOR_EMAIL. Derived attribute for displaying the creator E-Mail value in query results.

Supported API: false

Returns:

String

getCreatorName

public String getCreatorName()

Gets the value of the attribute: CREATOR_NAME. Derived attribute for displaying the creator name value in query results.

Supported API: false

Returns:

String

getCreatorFullName

public String getCreatorFullName()

Gets the value of the attribute: CREATOR_FULL_NAME. Derived attribute for displaying the creator fullname value in query results.

Supported API: false

Returns:

String

getCreator

public WTPrincipalReference getCreator()

Gets the object for the association that plays role: CREATOR. The reference to a persisted principal who created the object.

Supported API: false

Returns:

WTPrincipalReference

getName

public String getName()

Supported API: false

Specified by:

getName in interface CabinetBased

Returns:

String

initialize

protected void initialize()
                   throws WTException

Initializes objects created by new-factory methods.

Supported API: false

Overrides:

initialize in class WTObject

Throws:

WTException

getCabinetName

public String getCabinetName()

Gets the value of the attribute: CABINET_NAME.

Supported API: false

Specified by:

getCabinetName in interface Foldered

Returns:

String

getCabinet

public CabinetReference getCabinet()

Gets the value of the attribute: CABINET.

Supported API: false

Specified by:

getCabinet in interface Foldered

Returns:

CabinetReference

getFolderingInfo

public FolderingInfo getFolderingInfo()

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

Supported API: false

Specified by:

getFolderingInfo in interface Foldered

Returns:

FolderingInfo

setFolderingInfo

public void setFolderingInfo(FolderingInfo a_FolderingInfo)

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

Supported API: false

Specified by:

setFolderingInfo in interface Foldered

Parameters:

a_FolderingInfo -

getFolderPath

public String getFolderPath()

Gets the value of the attribute: FOLDER_PATH. The complete path for the object. The path includes the location with the name appended. This information is calculated.

Supported API: false

Specified by:

getFolderPath in interface CabinetBased

Returns:

String

getLocation

public String getLocation()

Gets the value of the attribute: LOCATION. The location, described as a path for the object. The location does not include the object's name, but rather indicates what Folder (Cabinet or SubFolder) that the object resides in. This information is calculated.

Supported API: false

Specified by:

getLocation in interface CabinetBased

Returns:

String

getCabinetReference

public CabinetReference getCabinetReference()

Gets the value of the attribute: CABINET_REFERENCE. A reference to the cabinet that the entry is consided part of.

Supported API: false

Specified by:

getCabinetReference in interface CabinetBased

Returns:

CabinetReference

isInheritedDomain

public boolean isInheritedDomain()

Gets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

isInheritedDomain in interface DomainAdministered

Returns:

boolean

setInheritedDomain

public void setInheritedDomain(boolean a_InheritedDomain)
                        throws WTPropertyVetoException

Sets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

setInheritedDomain in interface DomainAdministered

Parameters:

a_InheritedDomain -

Throws:

WTPropertyVetoException

getDomainRef

public AdminDomainRef getDomainRef()

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

Supported API: false

Specified by:

getDomainRef in interface DomainAdministered

Returns:

AdminDomainRef

setDomainRef

public void setDomainRef(AdminDomainRef a_DomainRef)

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

Supported API: false

Specified by:

setDomainRef in interface DomainAdministered

Parameters:

a_DomainRef -

getOwnership

public Ownership getOwnership()

Gets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

getOwnership in interface Ownable

Returns:

Ownership

setOwnership

public void setOwnership(Ownership a_Ownership)

Sets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

setOwnership in interface Ownable

Parameters:

a_Ownership -

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

Overrides:

getIdentity in class WTObject

Returns:

String

getBusinessType

public String getBusinessType()

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

Gets the value of the attribute: BUSINESS_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:

getBusinessType in interface BusinessInformation

Returns:

String

getEventSet

public WTStringSet getEventSet()

Gets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

getEventSet in interface Notifiable

Returns:

WTStringSet

setEventSet

public void setEventSet(WTStringSet a_EventSet)

Sets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

setEventSet in interface Notifiable

Parameters:

a_EventSet -

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