wt.enterprise
Class IteratedFolderResident

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

All Implemented Interfaces:

AccessControlled, CabinetBased, DisplayIdentification, DomainAdministered, Externalizable, Foldered, FolderEntry, FolderServiceManaged, Iterated, IteratedFoldered, Lockable, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, Serializable, Workable

Direct Known Subclasses:

LifeCycleTemplate, WTTypeDefinition

public abstract class IteratedFolderResident

extends WTObject

implements Workable, Notifiable, DomainAdministered, AccessControlled, Ownable, IteratedFoldered, Externalizable

This Workable (and therefor Iterated) first class information object is IteratedFoldered which allows special foldering behavior to take into account its Iterated nature when displaying it in a folder, and it is DomainAdministered; it is similar to a FolderResident except that it is Workable and is therefor rather than Foldered; it is neither LifeCycleManaged nor Versioned.

Supported API: true

Extendable: true

See Also:

"'The Enterprise Layer' in 'Application Developer's Guide'", "'vc package -- Version control service' 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 CheckoutInfo	checkoutInfo
private static String	CLASSNAME
private ControlBranch	controlBranch
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
private IterationInfo	iterationInfo
private Lock	lock
static String	MASTER Label for the attribute; The master for an iteration.
private ObjectReference	masterReference
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.vc.wip.Workable

CHECKOUT_INFO

Fields inherited from interface wt.vc.Iterated

BRANCH_IDENTIFIER, CONTROL_BRANCH, ITERATION_IDENTIFIER, ITERATION_INFO, ITERATION_NOTE, LATEST_ITERATION, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.locks.Lockable

LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAME

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

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.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

IteratedFolderResident()

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.
long	getBranchIdentifier() Gets the value of the attribute: BRANCH_IDENTIFIER.
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.
CheckoutInfo	getCheckoutInfo() Gets the object for the association that plays role: CHECKOUT_INFO.
ControlBranch	getControlBranch() Gets the value of the attribute: CONTROL_BRANCH.
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.
IterationIdentifier	getIterationIdentifier() Gets the value of the attribute: ITERATION_IDENTIFIER.
IterationInfo	getIterationInfo() Gets the object for the association that plays role: ITERATION_INFO.
String	getIterationNote() Gets the value of the attribute: ITERATION_NOTE.
String	getLocation() Gets the value of the attribute: LOCATION.
Lock	getLock() Gets the object for the association that plays role: LOCK.
Timestamp	getLockDate() Gets the value of the attribute: LOCK_DATE.
WTPrincipalReference	getLocker() Gets the value of the attribute: LOCKER.
String	getLockerEMail() Gets the value of the attribute: LOCKER_EMAIL.
String	getLockerFullName() Gets the value of the attribute: LOCKER_FULL_NAME.
String	getLockerName() Gets the value of the attribute: LOCKER_NAME.
String	getLockNote() Gets the value of the attribute: LOCK_NOTE.
Mastered	getMaster() Gets the object for the association that plays role: MASTER.
ObjectReference	getMasterReference() Gets the value of the attribute: MASTER_REFERENCE.
WTPrincipalReference	getModifier() Gets the value of the attribute: MODIFIER.
String	getModifierEMail() Gets the value of the attribute: MODIFIER_EMAIL.
String	getModifierFullName() Gets the value of the attribute: MODIFIER_FULL_NAME.
String	getModifierName() Gets the value of the attribute: MODIFIER_NAME.
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.
boolean	isLatestIteration() Gets the value of the attribute: LATEST_ITERATION.
boolean	isLocked() Gets the value of the attribute: LOCKED.
private void	iterationInfoValidate(IterationInfo a_IterationInfo)
private void	lockValidate(Lock a_Lock)
private void	masterReferenceValidate(ObjectReference a_MasterReference)
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(IteratedFolderResident thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCheckoutInfo(CheckoutInfo a_CheckoutInfo) Sets the object for the association that plays role: CHECKOUT_INFO.
void	setControlBranch(ControlBranch a_ControlBranch) Sets the value of the attribute: CONTROL_BRANCH.
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	setIterationInfo(IterationInfo a_IterationInfo) Sets the object for the association that plays role: ITERATION_INFO.
void	setLock(Lock a_Lock) Sets the object for the association that plays role: LOCK.
void	setMaster(Mastered a_Master) Sets the object for the association that plays role: MASTER.
void	setMasterReference(ObjectReference a_MasterReference) Sets the value of the attribute: MASTER_REFERENCE.
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, getIdentity, 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, getIdentity, 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

checkoutInfo

private CheckoutInfo checkoutInfo

controlBranch

private ControlBranch controlBranch

iterationInfo

private IterationInfo iterationInfo

MASTER

public static final String MASTER

Label for the attribute; The master for an iteration. A master must exist for any iteration.

Supported API: true

See Also:

Mastered, Constant Field Values

masterReference

private ObjectReference masterReference

lock

private Lock lock

ownership

private Ownership ownership

eventSet

private WTStringSet eventSet

inheritedDomain

private boolean inheritedDomain

domainRef

private AdminDomainRef domainRef

folderingInfo

private FolderingInfo folderingInfo

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

IteratedFolderResident

public IteratedFolderResident()

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

Specified by:

getCreatorEMail in interface Iterated

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

Specified by:

getCreatorName in interface Iterated

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

Specified by:

getCreatorFullName in interface Iterated

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

Specified by:

getCreator in interface Iterated

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

getCheckoutInfo

public CheckoutInfo getCheckoutInfo()

Gets the object for the association that plays role: CHECKOUT_INFO. The WIP cookie aggregated in any business object that asserts itself as being Workable.

Supported API: false

Specified by:

getCheckoutInfo in interface Workable

Returns:

CheckoutInfo

See Also:

CheckoutInfo

setCheckoutInfo

public void setCheckoutInfo(CheckoutInfo a_CheckoutInfo)
                     throws WTPropertyVetoException

Sets the object for the association that plays role: CHECKOUT_INFO. The WIP cookie aggregated in any business object that asserts itself as being Workable.

Supported API: false

Specified by:

setCheckoutInfo in interface Workable

Parameters:

a_CheckoutInfo -

Throws:

WTPropertyVetoException

See Also:

CheckoutInfo

getIterationNote

public String getIterationNote()

Gets the value of the attribute: ITERATION_NOTE. Derived attribute for displaying the iteration's note in query results.

Supported API: true

Specified by:

getIterationNote in interface Iterated

Returns:

String

getModifier

public WTPrincipalReference getModifier()

Gets the value of the attribute: MODIFIER. Derived attribute for displaying the iteration's modifier in query results.

Supported API: true

Specified by:

getModifier in interface Iterated

Returns:

WTPrincipalReference

getModifierEMail

public String getModifierEMail()

Gets the value of the attribute: MODIFIER_EMAIL. Derived attribute for displaying the iteration modifier's E-Mail address in query results.

Supported API: true

Specified by:

getModifierEMail in interface Iterated

Returns:

String

getModifierName

public String getModifierName()

Gets the value of the attribute: MODIFIER_NAME. Derived attribute for displaying the iteration modifier's name in query results.

Supported API: true

Specified by:

getModifierName in interface Iterated

Returns:

String

getModifierFullName

public String getModifierFullName()

Gets the value of the attribute: MODIFIER_FULL_NAME. Derived attribute for displaying the iteration modifier's fullname in query results.

Supported API: true

Specified by:

getModifierFullName in interface Iterated

Returns:

String

getIterationIdentifier

public IterationIdentifier getIterationIdentifier()

Gets the value of the attribute: ITERATION_IDENTIFIER. Derived attribute for displaying the iteration identifier in query results.

Supported API: true

Specified by:

getIterationIdentifier in interface Iterated

Returns:

IterationIdentifier

getBranchIdentifier

public long getBranchIdentifier()

Gets the value of the attribute: BRANCH_IDENTIFIER. Derived attribute for displaying the iteration's branch identifier in query results.

Supported API: false

Specified by:

getBranchIdentifier in interface Iterated

Returns:

long

isLatestIteration

public boolean isLatestIteration()

Gets the value of the attribute: LATEST_ITERATION. Derived attribute for displaying the iteration "latest" flag in query results.

Supported API: true

Specified by:

isLatestIteration in interface Iterated

Returns:

boolean

getControlBranch

public ControlBranch getControlBranch()

Gets the value of the attribute: CONTROL_BRANCH.

Supported API: true

Specified by:

getControlBranch in interface Iterated

Returns:

ControlBranch

setControlBranch

public void setControlBranch(ControlBranch a_ControlBranch)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTROL_BRANCH.

Supported API: true

Specified by:

setControlBranch in interface Iterated

Parameters:

a_ControlBranch -

Throws:

WTPropertyVetoException

getIterationInfo

public IterationInfo getIterationInfo()

Gets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

getIterationInfo in interface Iterated

Returns:

IterationInfo

See Also:

IterationInfo

setIterationInfo

public void setIterationInfo(IterationInfo a_IterationInfo)
                      throws WTPropertyVetoException

Sets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

setIterationInfo in interface Iterated

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

See Also:

IterationInfo

iterationInfoValidate

private void iterationInfoValidate(IterationInfo a_IterationInfo)
                            throws WTPropertyVetoException

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

getMaster

public Mastered getMaster()

Gets the object for the association that plays role: MASTER. The master for an iteration. A master must exist for any iteration.

Supported API: true

Specified by:

getMaster in interface Iterated

Returns:

Mastered

See Also:

Mastered

setMaster

public void setMaster(Mastered a_Master)
               throws WTPropertyVetoException,
                      WTException

Sets the object for the association that plays role: MASTER. The master for an iteration. A master must exist for any iteration.

Supported API: true

Specified by:

setMaster in interface Iterated

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

See Also:

Mastered

getMasterReference

public ObjectReference getMasterReference()

Gets the value of the attribute: MASTER_REFERENCE. The master for an iteration. A master must exist for any iteration.

Supported API: true

Specified by:

getMasterReference in interface Iterated

Returns:

ObjectReference

See Also:

Mastered

setMasterReference

public void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE. The master for an iteration. A master must exist for any iteration.

Supported API: true

Specified by:

setMasterReference in interface Iterated

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

See Also:

Mastered

masterReferenceValidate

private void masterReferenceValidate(ObjectReference a_MasterReference)
                              throws WTPropertyVetoException

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

isLocked

public boolean isLocked()

Gets the value of the attribute: LOCKED. Derived attribute for displaying the isSeized value in query results.

Supported API: false

Specified by:

isLocked in interface Lockable

Returns:

boolean

getLockDate

public Timestamp getLockDate()

Gets the value of the attribute: LOCK_DATE. Derived attribute for displaying the lock date value in query results.

Supported API: false

Specified by:

getLockDate in interface Lockable

Returns:

Timestamp

getLockNote

public String getLockNote()

Gets the value of the attribute: LOCK_NOTE. Derived attribute for displaying the lock note value in query results.

Supported API: false

Specified by:

getLockNote in interface Lockable

Returns:

String

getLocker

public WTPrincipalReference getLocker()

Gets the value of the attribute: LOCKER. Derived attribute for querying for the locker.

Supported API: false

Specified by:

getLocker in interface Lockable

Returns:

WTPrincipalReference

getLockerEMail

public String getLockerEMail()

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

Supported API: false

Specified by:

getLockerEMail in interface Lockable

Returns:

String

getLockerName

public String getLockerName()

Gets the value of the attribute: LOCKER_NAME. Derived attribute for displaying the locker name value in query results.

Supported API: false

Specified by:

getLockerName in interface Lockable

Returns:

String

getLockerFullName

public String getLockerFullName()

Gets the value of the attribute: LOCKER_FULL_NAME. Derived attribute for displaying the lock fullname value in query results.

Supported API: false

Specified by:

getLockerFullName in interface Lockable

Returns:

String

getLock

public Lock getLock()

Gets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

getLock in interface Lockable

Returns:

Lock

See Also:

Lock

setLock

public void setLock(Lock a_Lock)
             throws WTPropertyVetoException

Sets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

setLock in interface Lockable

Parameters:

a_Lock -

Throws:

WTPropertyVetoException

See Also:

Lock

lockValidate

private void lockValidate(Lock a_Lock)
                   throws WTPropertyVetoException

Parameters:

a_Lock -

Throws:

WTPropertyVetoException

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 -

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 -

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 -

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

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