wt.epm.clients.relateditems
Class FamilyTableOptions

java.lang.Object
  wt.epm.clients.relateditems.FamilyTableOptions

public class FamilyTableOptions

extends Object

Specifies which compatible family table to choose and which family members from that family table to return. An instance of this class may be passed as an option to the Document-Centric or Part-Centric Processor.

Supported API: false

Extendable: false

Field Summary

boolean	excludeCheckedOut When choosing a family table, exclude family tables that are marked as checked out (i.e.
boolean	onlyInProject Return only those family members that reside in or are shared to this project.
WTContainerRef	projectRef When choosing a family table, prefer one that has members that reside in this project over one that does not.

Constructor Summary

protected	FamilyTableOptions(EPMDocConfigSpec configSpec)
	FamilyTableOptions(WTContainerRef projectRef, boolean onlyInProject, boolean excludeCheckedOut) Constructs an FamilyTableOptions object that specifies which compatible family table to choose and which family members from that family table to return.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

projectRef

public WTContainerRef projectRef

When choosing a family table, prefer one that has members that reside in this project over one that does not.

onlyInProject

public boolean onlyInProject

Return only those family members that reside in or are shared to this project. This option is ignored if the project reference is null.

excludeCheckedOut

public boolean excludeCheckedOut

When choosing a family table, exclude family tables that are marked as checked out (i.e. at least one of its members is a working copy).

Constructor Detail

FamilyTableOptions

public FamilyTableOptions(WTContainerRef projectRef,
                          boolean onlyInProject,
                          boolean excludeCheckedOut)

Constructs an FamilyTableOptions object that specifies which compatible family table to choose and which family members from that family table to return.

Parameters:

projectRef - - choose a family table that has members that reside in this project over one that does not

onlyInProject - - return only those family members that reside in or are shared to this project

excludeCheckedOut - - exclude family tables that are marked as checked out

FamilyTableOptions

protected FamilyTableOptions(EPMDocConfigSpec configSpec)