wt.fc
Interface Link

All Superinterfaces:

NetFactor, ObjectMappable, Persistable, Serializable

All Known Subinterfaces:

BinaryLink, BuildableLink, BuildRule, CurrentPhase, FolderMembership, ForumSubject, NotebookSubject, ObjectGraphEdge, ObjectGraphEdgeTemplate, OccurrenceableLink, Shortcut, WTPartDocumentLink

All Known Implementing Classes:

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

public interface Link

extends Persistable

Link is the interface that represents any kind of associations between two or more domain-specific objects.

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 Deprecated.
static String	ROLE_AOBJECT_ROLE Deprecated.
static String	ROLE_BOBJECT_REF Deprecated.
static String	ROLE_BOBJECT_ROLE Deprecated.

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Method Summary

QuerySpec	appendJoinCriteria(Persistable obj, String otherSideRole, QuerySpec qs, int targetPos, int linkPos) Appends applicable search condition(s) onto the end of the given query spec based on the role to be navigate to and the attributes of the given object.
QuerySpec	appendRoleCriteria(Persistable obj, String role, QuerySpec qs, int linkPos) Appends applicable search condition(s) onto the end of the given query spec based on the role and the attributes of the given object.
Object[]	getAllObjects() Gets all the role objects of this link.
Object[]	getJoinValues(Persistable obj, String otherSideRole) Gets an array of values in the same order as the query was appended with search conditions.
LinkInfo	getLinkInfo() Supported API: false
Persistable	getObject(String role) Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).
Persistable	getOtherObject(Persistable obj) Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).
String	getRole(Persistable obj) Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).
Persistable	getRoleAObject() Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).
QueryKey	getRoleAObjectId() Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).
WTReference	getRoleAObjectRef() Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).
Persistable	getRoleBObject() Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).
QueryKey	getRoleBObjectId() Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).
WTReference	getRoleBObjectRef() Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).
String	getRoleIdName(String rolename) Gets the role's key id attribute name of this link for the given role name.
Object	getRoleObject(String rolename) Gets the role object of this link for the given role name.
void	setRoleAObject(Persistable roleAObject) Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).
void	setRoleAObjectRef(WTReference a_RoleAObjectRef) Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).
void	setRoleBObject(Persistable roleBObject) Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).
void	setRoleBObjectRef(WTReference a_RoleBObjectRef) Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).
void	setRoleObject(Object roleObject, String rolename) Sets the role object of this link for the given role name.

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

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_ROLE

public static final String ROLE_AOBJECT_ROLE

Deprecated.

Supported API: false

See Also:

Constant Field Values

ROLE_BOBJECT_ROLE

public static final String ROLE_BOBJECT_ROLE

Deprecated.

Supported API: false

See Also:

Constant Field Values

ROLE_AOBJECT_REF

public static final String ROLE_AOBJECT_REF

Deprecated.

Supported API: false

See Also:

Constant Field Values

ROLE_BOBJECT_REF

public static final String ROLE_BOBJECT_REF

Deprecated.

Supported API: false

See Also:

Constant Field Values

Method Detail

getLinkInfo

public LinkInfo getLinkInfo()
                     throws WTIntrospectionException

Supported API: false

Returns:

LinkInfo

Throws:

WTIntrospectionException

getObject

public Persistable getObject(String role)
                      throws WTException,
                             InvalidRoleException

Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).

Supported API: false

Parameters:

role -

Returns:

Persistable

Throws:

WTException

InvalidRoleException

getOtherObject

public Persistable getOtherObject(Persistable obj)
                           throws ObjectNotForLinkException

Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).

Supported API: false

Parameters:

obj -

Returns:

Persistable

Throws:

ObjectNotForLinkException

getRole

public String getRole(Persistable obj)
               throws WTException,
                      ObjectNotForLinkException

Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).

Supported API: false

Parameters:

obj -

Returns:

String

Throws:

WTException

ObjectNotForLinkException

getRoleAObject

public Persistable getRoleAObject()

Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).

Supported API: false

Returns:

Persistable

setRoleAObject

public void setRoleAObject(Persistable roleAObject)

Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).

Supported API: false

Parameters:

roleAObject - The role A object for this Link.

getRoleAObjectId

public QueryKey getRoleAObjectId()

Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).

Supported API: false

Returns:

QueryKey

getRoleAObjectRef

public WTReference getRoleAObjectRef()

Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).

Supported API: false

Returns:

WTReference

setRoleAObjectRef

public void setRoleAObjectRef(WTReference a_RoleAObjectRef)

Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).

Supported API: false

Parameters:

a_RoleAObjectRef - The role A object for this Link.

getRoleBObject

public Persistable getRoleBObject()

Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).

Supported API: false

Returns:

Persistable

setRoleBObject

public void setRoleBObject(Persistable roleBObject)

Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).

Supported API: false

Parameters:

roleBObject - The role B object for this Link.

getRoleBObjectId

public QueryKey getRoleBObjectId()

Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).

Supported API: false

Returns:

QueryKey

getRoleBObjectRef

public WTReference getRoleBObjectRef()

Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).

Supported API: false

Returns:

WTReference

setRoleBObjectRef

public void setRoleBObjectRef(WTReference a_RoleBObjectRef)

Deprecated. replaced by same named method on the BinaryLink abstraction (i.e., no longer valid for this generalization).

Supported API: false

Parameters:

a_RoleBObjectRef - The role A object for this Link.

getAllObjects

public Object[] getAllObjects()

Gets all the role objects of this link.

Supported API: false

Returns:

Object[]

getRoleObject

public Object getRoleObject(String rolename)
                     throws WTException

Gets the role object of this link for the given role name.

Supported API: false

Parameters:

rolename -

Returns:

Object

Throws:

WTException

setRoleObject

public void setRoleObject(Object roleObject,
                          String rolename)
                   throws WTException

Sets the role object of this link for the given role name.

Supported API: false

Parameters:

roleObject - The role A object for this Link.

rolename -

Throws:

WTException

getRoleIdName

public String getRoleIdName(String rolename)
                     throws WTException

Gets the role's key id attribute name of this link for the given role name.

Supported API: false

Parameters:

rolename -

Returns:

String

Throws:

WTException

appendJoinCriteria

public QuerySpec appendJoinCriteria(Persistable obj,
                                    String otherSideRole,
                                    QuerySpec qs,
                                    int targetPos,
                                    int linkPos)
                             throws WTException

Appends applicable search condition(s) onto the end of the given query spec based on the role to be navigate to and the attributes of the given object.

Supported API: false

Parameters:

obj -

otherSideRole -

qs -

targetPos -

linkPos -

Returns:

QuerySpec

Throws:

WTException

getJoinValues

public Object[] getJoinValues(Persistable obj,
                              String otherSideRole)
                       throws WTException

Gets an array of values in the same order as the query was appended with search conditions.

Supported API: false

Parameters:

obj -

otherSideRole -

Returns:

Object[]

Throws:

WTException

appendRoleCriteria

public QuerySpec appendRoleCriteria(Persistable obj,
                                    String role,
                                    QuerySpec qs,
                                    int linkPos)
                             throws WTException

Appends applicable search condition(s) onto the end of the given query spec based on the role and the attributes of the given object.

Supported API: false

Parameters:

obj -

role -

qs -

linkPos -

Returns:

QuerySpec

Throws:

WTException