wt.folder
Class IteratedFolderMemberLink

java.lang.Object
  wt.fc.WTObject
      wt.vc.ObjectToVersionLink
          wt.folder.IteratedFolderMemberLink

All Implemented Interfaces:

BinaryLink, DisplayIdentification, Externalizable, FolderEntryLink, FolderMembership, FolderServiceManaged, Link, NetFactor, ObjectMappable, Persistable, Serializable

public final class IteratedFolderMemberLink

extends ObjectToVersionLink

implements FolderMembership, Externalizable

Holds a persistent association between a Folder (Cabinet or SubFolder) and the latest iteration of an IteratedFoldered object (it's member). A Foldered object may be a member of one and only one Folder. To add/remove a member to/from a Folder, the user must have modify permission on the Folder.

Use the newIteratedFolderMemberLink static factory method(s), not the IteratedFolderMemberLink 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: true

Extendable: false

See Also:

Cabinet, SubFolder, Foldered, Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	FOLDER_ROLE Label for the attribute; The Folder containing object of the FolderMembership association.
static String	MEMBER_ROLE Label for the attribute; The FolderEntry object which performs the member role (i.e.
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.vc.ObjectToVersionLink

ROLE_AOBJECT_REF, ROLE_BOBJECT_REF

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.fc.BinaryLink

ALL_ROLES, BOTH_ROLES, ROLE_AOBJECT_REF, ROLE_AOBJECT_ROLE, ROLE_BOBJECT_REF, ROLE_BOBJECT_ROLE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

IteratedFolderMemberLink()

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	getConceptualClassname() Deprecated.
FolderEntry	getEntry() Supported API: false
Folder	getFolder() Supported API: false
Foldered	getFoldered()
FolderEntry	getMember() Gets the object for the association that plays role: MEMBER_ROLE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static IteratedFolderMemberLink	newIteratedFolderMemberLink(Folder folder, IteratedFoldered member) 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(IteratedFolderMemberLink thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setFolder(Folder folder) Supported API: false
void	setMember(FolderEntry member) Sets the object for the association that plays role: MEMBER_ROLE.
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.vc.ObjectToVersionLink

appendJoinCriteria, appendRoleCriteria, duplicate, getAllObjects, getJoinValues, getLinkInfo, getObject, getOtherObject, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, getRoleIdName, getRoleObject, initialize, readVersion, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef, setRoleObject

Methods inherited from class wt.fc.WTObject

checkAttributes, 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

Methods inherited from interface wt.fc.BinaryLink

getLinkInfo, getObject, getOtherObject, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef

Methods inherited from interface wt.fc.Link

appendJoinCriteria, appendRoleCriteria, getAllObjects, getJoinValues, getRoleIdName, getRoleObject, setRoleObject

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

FOLDER_ROLE

public static final String FOLDER_ROLE

Label for the attribute; The Folder containing object of the FolderMembership association.

Supported API: false

See Also:

Constant Field Values

MEMBER_ROLE

public static final String MEMBER_ROLE

Label for the attribute; The FolderEntry object which performs the member role (i.e. the contained object) in the FolderMembership association.

Supported API: false

See Also:

Constant Field Values

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

IteratedFolderMemberLink

public IteratedFolderMemberLink()

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 ObjectToVersionLink

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 ObjectToVersionLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(IteratedFolderMemberLink 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 ObjectToVersionLink

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 ObjectToVersionLink

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

newIteratedFolderMemberLink

public static IteratedFolderMemberLink newIteratedFolderMemberLink(Folder folder,
                                                                   IteratedFoldered member)
                                                            throws WTException

Default factory for the class.

Supported API: false

Parameters:

folder -

member -

Returns:

IteratedFolderMemberLink

Throws:

WTException

getFolder

public Folder getFolder()

Supported API: false

Specified by:

getFolder in interface FolderMembership

Returns:

Folder

setFolder

public void setFolder(Folder folder)

Supported API: false

Specified by:

setFolder in interface FolderMembership

Parameters:

folder -

getEntry

public FolderEntry getEntry()

Supported API: false

Specified by:

getEntry in interface FolderEntryLink

Returns:

FolderEntry

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 ObjectToVersionLink

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 ObjectToVersionLink

Returns:

int

getMember

public FolderEntry getMember()

Description copied from interface: FolderMembership

Gets the object for the association that plays role: MEMBER_ROLE. The FolderEntry object which performs the member role (i.e. the contained object) in the FolderMembership association.

Supported API: false

Specified by:

getMember in interface FolderMembership

Returns:

FolderEntry

setMember

public void setMember(FolderEntry member)

Description copied from interface: FolderMembership

Sets the object for the association that plays role: MEMBER_ROLE. The FolderEntry object which performs the member role (i.e. the contained object) in the FolderMembership association.

Supported API: false

Specified by:

setMember in interface FolderMembership

Parameters:

member -

getFoldered

public Foldered getFoldered()