wt.folder
Class DynamicFolderMembershipLink

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          wt.folder.DynamicFolderMembershipLink

All Implemented Interfaces:

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

public class DynamicFolderMembershipLink

extends ObjectToObjectLink

implements FolderMembership, Externalizable

Holds a persistent association between a Folder (Cabinet or SubFolder) and a Foldered 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 newDynamicFolderMembershipLink static factory method(s), not the DynamicFolderMembershipLink 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.

See Also:

Cabinet, SubFolder, Foldered, Serialized Form

Field Summary

private static String	CLASSNAME
static String	FOLDER_ROLE Label for the attribute.
static String	MEMBER_ROLE Label for the attribute.
private static String	RESOURCE
(package private) static long	serialVersionUID
private static String	versionID

Fields inherited from class wt.fc.ObjectToObjectLink

EXTERNALIZATION_VERSION_UID, OLD_FORMAT_VERSION_UID, 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

DynamicFolderMembershipLink()

Method Summary

String	getConceptualClassname() Returns the conceptual (modeled) name for the class.
FolderEntry	getEntry() Supported API: false
Folder	getFolder() Gets the object for the association that plays role: FOLDER_ROLE.
Foldered	getFoldered()
FolderEntry	getMember() Gets the object for the association that plays role: MEMBER_ROLE.
static DynamicFolderMembershipLink	newDynamicFolderMembershipLink(Folder folder, FolderEntry 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 void	readOldVersion(ObjectInput input, long readSerialVersionUID) Reads the non-transient fields of this class from an external source, which is not the current version.
void	setFolder(Folder folder) Sets the object for the association that plays role: FOLDER_ROLE.
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.fc.ObjectToObjectLink

appendJoinCriteria, appendRoleCriteria, duplicate, equals, getAllObjects, getJoinValues, getLinkInfo, getObject, getOtherObject, getRemoteRoleAObjectId, getRemoteRoleBObjectId, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, getRoleIdName, getRoleObject, hashCode, initialize, isRoleANonpersistentProxy, isRoleBNonpersistentProxy, 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

versionID

private static final String versionID

See Also:

Constant Field Values

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

FOLDER_ROLE

public static final String FOLDER_ROLE

Label for the attribute.

See Also:

Constant Field Values

MEMBER_ROLE

public static final String MEMBER_ROLE

Label for the attribute.

See Also:

Constant Field Values

Constructor Detail

DynamicFolderMembershipLink

public DynamicFolderMembershipLink()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class ObjectToObjectLink

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.

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class ObjectToObjectLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readOldVersion

private void readOldVersion(ObjectInput input,
                            long readSerialVersionUID)
                     throws IOException,
                            ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

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.)

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class ObjectToObjectLink

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.)

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class ObjectToObjectLink

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Returns the conceptual (modeled) name for the class.

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

newDynamicFolderMembershipLink

public static DynamicFolderMembershipLink newDynamicFolderMembershipLink(Folder folder,
                                                                         FolderEntry member)
                                                                  throws WTException

Default factory for the class.

Parameters:

folder -

Returns:

DynamicFolderMembershipLink

Throws:

WTException

getFolder

public Folder getFolder()

Description copied from interface: FolderMembership

Gets the object for the association that plays role: FOLDER_ROLE. The Folder containing object of the FolderMembership association.

Supported API: false

Specified by:

getFolder in interface FolderMembership

Returns:

Folder

setFolder

public void setFolder(Folder folder)

Description copied from interface: FolderMembership

Sets the object for the association that plays role: FOLDER_ROLE. The Folder containing object of the FolderMembership association.

Supported API: false

Specified by:

setFolder in interface FolderMembership

Parameters:

folder -

getEntry

public FolderEntry getEntry()

Description copied from interface: FolderEntryLink

Supported API: false

Specified by:

getEntry in interface FolderEntryLink

Returns:

FolderEntry

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