wt.fc
Interface BinaryLink

All Superinterfaces:

Link, NetFactor, ObjectMappable, Persistable, Serializable

All Known Subinterfaces:

BuildableLink, BuildRule, CurrentPhase, FolderMembership, ForumSubject, NotebookSubject, OccurrenceableLink, Shortcut, WTPartDocumentLink

All Known Implementing Classes:

CurrentPhaseLink, DynamicFolderMembershipLink, EPMBuildRule, EPMMemberLink, FolderMemberLink, ForumSubjectLink, IteratedCurrentPhaseLink, IteratedFolderMemberLink, IteratedForumSubjectLink, IteratedNotebookSubjectLink, IteratedShortcutLink, NotebookSubjectLink, ObjectToObjectLink, ObjectToVersionLink, ShortcutLink, VersionToVersionLink, WTPartDescribeLink, WTPartReferenceLink, WTPartUsageLink

public interface BinaryLink

extends Link

Interfaces that represents an association between two objects. Those objects are referenced via the WTReference interface.

Supported API: true

Extendable: true

Field Summary

static String	ALL_ROLES Supported API: false
static String	BOTH_ROLES Deprecated. replaced by ALL_ROLES
static String	ROLE_AOBJECT_REF Supported API: false
static String	ROLE_AOBJECT_ROLE Label for the attribute.
static String	ROLE_BOBJECT_REF Supported API: false
static String	ROLE_BOBJECT_ROLE Label for the attribute.

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Method Summary

LinkInfo	getLinkInfo() Gets the LinkInfo object for this Link Supported API: false
Persistable	getObject(String role) Deprecated. replaced by getRoleObject(String)
Persistable	getOtherObject(Persistable obj) Gets this link's other side role.
String	getRole(Persistable obj) Gets this link's role name.
Persistable	getRoleAObject() Gets the role A object of this Link for this Link.
QueryKey	getRoleAObjectId() Gets the object id of the role A object for this Link.
WTReference	getRoleAObjectRef() Gets the object for the association that plays role: ROLE_AOBJECT_REF.
Persistable	getRoleBObject() Gets the role B object of this Link for this Link.
QueryKey	getRoleBObjectId() Gets the object id of the role B object for this Link.
WTReference	getRoleBObjectRef() Gets the object for the association that plays role: ROLE_BOBJECT_REF.
void	setRoleAObject(Persistable roleAObject) Sets the role A object for this Link.
void	setRoleAObjectRef(WTReference a_RoleAObjectRef) Sets the object for the association that plays role: ROLE_AOBJECT_REF.
void	setRoleBObject(Persistable roleBObject) Sets the role B object for this Link.
void	setRoleBObjectRef(WTReference a_RoleBObjectRef) Sets the object for the association that plays role: ROLE_BOBJECT_REF.

Methods inherited from interface wt.fc.Link

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

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.ObjectMappable

readExternal, writeExternal

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

ROLE_AOBJECT_ROLE

public static final String ROLE_AOBJECT_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ROLE_BOBJECT_ROLE

public static final String ROLE_BOBJECT_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ALL_ROLES

public static final String ALL_ROLES

Supported API: false

See Also:

Constant Field Values

BOTH_ROLES

public static final String BOTH_ROLES

Deprecated. replaced by ALL_ROLES

Supported API: false

See Also:

Constant Field Values

ROLE_AOBJECT_REF

public static final String ROLE_AOBJECT_REF

Supported API: false

See Also:

Constant Field Values

ROLE_BOBJECT_REF

public static final String ROLE_BOBJECT_REF

Supported API: false

See Also:

Constant Field Values

Method Detail

getRoleAObjectRef

public WTReference getRoleAObjectRef()

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

Supported API: false

Specified by:

getRoleAObjectRef in interface Link

Returns:

WTReference

setRoleAObjectRef

public void setRoleAObjectRef(WTReference a_RoleAObjectRef)

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

Supported API: false

Specified by:

setRoleAObjectRef in interface Link

Parameters:

a_RoleAObjectRef -

getRoleBObjectRef

public WTReference getRoleBObjectRef()

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

Supported API: false

Specified by:

getRoleBObjectRef in interface Link

Returns:

WTReference

setRoleBObjectRef

public void setRoleBObjectRef(WTReference a_RoleBObjectRef)

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

Supported API: false

Specified by:

setRoleBObjectRef in interface Link

Parameters:

a_RoleBObjectRef -

getLinkInfo

public LinkInfo getLinkInfo()
                     throws WTIntrospectionException

Gets the LinkInfo object for this Link

Supported API: false

Specified by:

getLinkInfo in interface Link

Returns:

LinkInfo

Throws:

WTIntrospectionException

getObject

public Persistable getObject(String role)
                      throws WTException,
                             InvalidRoleException

Deprecated. replaced by getRoleObject(String)

Gets a Persistable object associated by this link given a role.

Supported API: false

Specified by:

getObject in interface Link

Parameters:

role -

Returns:

Persistable

Throws:

WTException

InvalidRoleException

getOtherObject

public Persistable getOtherObject(Persistable obj)
                           throws ObjectNotForLinkException

Gets this link's other side role.

Supported API: false

Specified by:

getOtherObject in interface Link

Parameters:

obj -

Returns:

Persistable

Throws:

ObjectNotForLinkException

getRole

public String getRole(Persistable obj)
               throws WTException,
                      ObjectNotForLinkException

Gets this link's role name.

Supported API: false

Specified by:

getRole in interface Link

Parameters:

obj -

Returns:

String

Throws:

WTException

ObjectNotForLinkException

getRoleAObject

public Persistable getRoleAObject()

Gets the role A object of this Link for this Link.

Supported API: false

Specified by:

getRoleAObject in interface Link

Returns:

Persistable

setRoleAObject

public void setRoleAObject(Persistable roleAObject)

Sets the role A object for this Link.

Supported API: false

Specified by:

setRoleAObject in interface Link

Parameters:

roleAObject - The role A object for this Link.

getRoleAObjectId

public QueryKey getRoleAObjectId()

Gets the object id of the role A object for this Link.

Supported API: false

Specified by:

getRoleAObjectId in interface Link

Returns:

QueryKey

getRoleBObject

public Persistable getRoleBObject()

Gets the role B object of this Link for this Link.

Supported API: false

Specified by:

getRoleBObject in interface Link

Returns:

Persistable

setRoleBObject

public void setRoleBObject(Persistable roleBObject)

Sets the role B object for this Link.

Supported API: false

Specified by:

setRoleBObject in interface Link

Parameters:

roleBObject - The role B object for this Link.

getRoleBObjectId

public QueryKey getRoleBObjectId()

Gets the object id of the role B object for this Link.

Supported API: false

Specified by:

getRoleBObjectId in interface Link

Returns:

QueryKey