|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectwt.fc.WTObject
wt.epm.workspaces.EPMWorkspace
public class EPMWorkspace
The EPMWorkspace is an EPM-specific workspace.
It contains a set of objects being worked on (the EPMCheckpoint), and has an associated Windchill Folder. Any object Checked Out to the Folder is regarded as in the workspace.
Use the newEPMWorkspace static factory method(s), not the
EPMWorkspace 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
| Field Summary | |
|---|---|
static String |
CONTAINER
Label for the attribute; WTContainer to be used for new objects in EPMWorkspace. |
static String |
CONTAINER_REFERENCE
Label for the attribute; WTContainer to be used for new objects in EPMWorkspace. |
static String |
DESCRIPTION
Label for the attribute; A description of the workspace. |
static String |
DIRECTORY
Label for the attribute; The directory in which Checked Out files associated with the EPMWorkspace are stored. |
static String |
DOC_CONFIG_SPEC
Label for the attribute. |
static String |
DOC_CONFIG_SPEC_REFERENCE
Label for the attribute. |
static String |
DOC_FOLDER
Label for the attribute. |
static String |
DOC_FOLDER_REFERENCE
Label for the attribute. |
static String |
DOC_LIFE_CYCLE
Label for the attribute. |
static String |
DOC_LIFE_CYCLE_REFERENCE
Label for the attribute. |
static String |
FOLDER
Label for the attribute. |
static String |
FOLDER_REFERENCE
Label for the attribute. |
static String |
NAME
Label for the attribute; The name of the EPMWorkspace. |
static String |
PART_CENTRIC_PROCESSING
Label for the attribute; true/false flag to indicate if primary dependency processing is to be done on PartCentric mode. |
static String |
PART_CONFIG_SPEC
Label for the attribute. |
static String |
PART_CONFIG_SPEC_REFERENCE
Label for the attribute. |
static String |
PART_FOLDER
Label for the attribute. |
static String |
PART_FOLDER_REFERENCE
Label for the attribute. |
static String |
PART_LIFE_CYCLE
Label for the attribute. |
static String |
PART_LIFE_CYCLE_REFERENCE
Label for the attribute. |
static String |
PRINCIPAL_REFERENCE
Label for the attribute. |
static String |
TEAM_TEMPLATE
Label for the attribute. |
static String |
TEAM_TEMPLATE_REFERENCE
Label for the attribute. |
static String |
VIEW
Label for the attribute; View to be used for new WTParts in EPMWorkspace Supported API: true |
static String |
VIEW_EXPLICITLY_SET
Label for the attribute; true/false flag to indicate if the view reference has been set by the client Supported API: true |
static String |
VIEW_REFERENCE
Label for the attribute; View to be used for new WTParts in EPMWorkspace Supported API: true |
| Method Summary | |
|---|---|
WTContainer |
getContainer()
Gets the object for the association that plays role: CONTAINER. |
ObjectReference |
getContainerReference()
Gets the value of the attribute: CONTAINER_REFERENCE. |
String |
getDescription()
Gets the value of the attribute: DESCRIPTION. |
File |
getDirectory()
Gets the value of the attribute: DIRECTORY. |
EPMDocConfigSpec |
getDocConfigSpec()
Gets the object for the association that plays role: DOC_CONFIG_SPEC. |
ObjectReference |
getDocConfigSpecReference()
Gets the value of the attribute: DOC_CONFIG_SPEC_REFERENCE. |
Folder |
getDocFolder()
Gets the object for the association that plays role: DOC_FOLDER. |
ObjectReference |
getDocFolderReference()
Gets the value of the attribute: DOC_FOLDER_REFERENCE. |
wt.lifecycle.LifeCycleTemplateMaster |
getDocLifeCycle()
Gets the object for the association that plays role: DOC_LIFE_CYCLE. |
ObjectReference |
getDocLifeCycleReference()
Gets the value of the attribute: DOC_LIFE_CYCLE_REFERENCE. |
Folder |
getFolder()
Gets the object for the association that plays role: FOLDER. |
ObjectReference |
getFolderReference()
Gets the value of the attribute: FOLDER_REFERENCE. |
String |
getName()
Gets the value of the attribute: NAME. |
WTPartConfigSpec |
getPartConfigSpec()
Gets the object for the association that plays role: PART_CONFIG_SPEC. |
ObjectReference |
getPartConfigSpecReference()
Gets the value of the attribute: PART_CONFIG_SPEC_REFERENCE. |
Folder |
getPartFolder()
Gets the object for the association that plays role: PART_FOLDER. |
ObjectReference |
getPartFolderReference()
Gets the value of the attribute: PART_FOLDER_REFERENCE. |
wt.lifecycle.LifeCycleTemplateMaster |
getPartLifeCycle()
Gets the object for the association that plays role: PART_LIFE_CYCLE. |
ObjectReference |
getPartLifeCycleReference()
Gets the value of the attribute: PART_LIFE_CYCLE_REFERENCE. |
WTPrincipalReference |
getPrincipalReference()
Gets the object for the association that plays role: PRINCIPAL_REFERENCE. |
wt.team.TeamTemplate |
getTeamTemplate()
Gets the object for the association that plays role: TEAM_TEMPLATE. |
ObjectReference |
getTeamTemplateReference()
Gets the value of the attribute: TEAM_TEMPLATE_REFERENCE. |
View |
getView()
Gets the object for the association that plays role: VIEW. |
ObjectReference |
getViewReference()
Gets the value of the attribute: VIEW_REFERENCE. |
protected void |
initialize(String name,
WTPrincipal principal,
Folder folder,
WTPartConfigSpec partConfigSpec,
EPMDocConfigSpec docConfigSpec,
WTContainer container)
Supports initialization, following construction of an instance. |
boolean |
isPartCentricProcessing()
Gets the value of the attribute: PART_CENTRIC_PROCESSING. |
boolean |
isViewExplicitlySet()
Gets the value of the attribute: VIEW_EXPLICITLY_SET. |
static EPMWorkspace |
newEPMWorkspace(String name,
WTPrincipal principal,
Folder folder,
WTPartConfigSpec partConfigSpec,
EPMDocConfigSpec docConfigSpec,
WTContainer container)
Supported API: true |
void |
setContainer(WTContainer a_Container)
Sets the object for the association that plays role: CONTAINER. |
void |
setContainerReference(ObjectReference a_ContainerReference)
Sets the value of the attribute: CONTAINER_REFERENCE. |
void |
setDescription(String a_Description)
Sets the value of the attribute: DESCRIPTION. |
void |
setDirectory(File a_Directory)
Sets the value of the attribute: DIRECTORY. |
void |
setDocConfigSpec(EPMDocConfigSpec a_DocConfigSpec)
Sets the object for the association that plays role: DOC_CONFIG_SPEC. |
void |
setDocConfigSpecReference(ObjectReference a_DocConfigSpecReference)
Sets the value of the attribute: DOC_CONFIG_SPEC_REFERENCE. |
void |
setDocFolder(Folder a_DocFolder)
Sets the object for the association that plays role: DOC_FOLDER. |
void |
setDocFolderReference(ObjectReference a_DocFolderReference)
Sets the value of the attribute: DOC_FOLDER_REFERENCE. |
void |
setDocLifeCycle(wt.lifecycle.LifeCycleTemplateMaster a_DocLifeCycle)
Sets the object for the association that plays role: DOC_LIFE_CYCLE. |
void |
setDocLifeCycleReference(ObjectReference a_DocLifeCycleReference)
Sets the value of the attribute: DOC_LIFE_CYCLE_REFERENCE. |
void |
setFolder(Folder a_Folder)
Sets the object for the association that plays role: FOLDER. |
void |
setFolderReference(ObjectReference a_FolderReference)
Sets the value of the attribute: FOLDER_REFERENCE. |
void |
setName(String a_Name)
Sets the value of the attribute: NAME. |
void |
setPartCentricProcessing(boolean a_PartCentricProcessing)
Sets the value of the attribute: PART_CENTRIC_PROCESSING. |
void |
setPartConfigSpec(WTPartConfigSpec a_PartConfigSpec)
Sets the object for the association that plays role: PART_CONFIG_SPEC. |
void |
setPartConfigSpecReference(ObjectReference a_PartConfigSpecReference)
Sets the value of the attribute: PART_CONFIG_SPEC_REFERENCE. |
void |
setPartFolder(Folder a_PartFolder)
Sets the object for the association that plays role: PART_FOLDER. |
void |
setPartFolderReference(ObjectReference a_PartFolderReference)
Sets the value of the attribute: PART_FOLDER_REFERENCE. |
void |
setPartLifeCycle(wt.lifecycle.LifeCycleTemplateMaster a_PartLifeCycle)
Sets the object for the association that plays role: PART_LIFE_CYCLE. |
void |
setPartLifeCycleReference(ObjectReference a_PartLifeCycleReference)
Sets the value of the attribute: PART_LIFE_CYCLE_REFERENCE. |
void |
setPrincipalReference(WTPrincipalReference a_PrincipalReference)
Sets the object for the association that plays role: PRINCIPAL_REFERENCE. |
void |
setTeamTemplate(wt.team.TeamTemplate a_TeamTemplate)
Sets the object for the association that plays role: TEAM_TEMPLATE. |
void |
setTeamTemplateReference(ObjectReference a_TeamTemplateReference)
Sets the value of the attribute: TEAM_TEMPLATE_REFERENCE. |
void |
setView(View a_View)
Sets the object for the association that plays role: VIEW. |
void |
setViewExplicitlySet(boolean a_ViewExplicitlySet)
Sets the value of the attribute: VIEW_EXPLICITLY_SET. |
void |
setViewReference(ObjectReference a_ViewReference)
Sets the value of the attribute: VIEW_REFERENCE. |
| Methods inherited from class wt.fc.WTObject |
|---|
getDisplayIdentifier, getDisplayIdentity, getDisplayType |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final String NAME
public static final String DIRECTORY
public static final String DESCRIPTION
public static final String PART_CENTRIC_PROCESSING
public static final String VIEW_EXPLICITLY_SET
public static final String FOLDER
public static final String FOLDER_REFERENCE
public static final String PART_CONFIG_SPEC
public static final String PART_CONFIG_SPEC_REFERENCE
public static final String DOC_CONFIG_SPEC
public static final String DOC_CONFIG_SPEC_REFERENCE
public static final String PRINCIPAL_REFERENCE
public static final String DOC_LIFE_CYCLE
public static final String DOC_LIFE_CYCLE_REFERENCE
public static final String PART_LIFE_CYCLE
public static final String PART_LIFE_CYCLE_REFERENCE
public static final String DOC_FOLDER
public static final String DOC_FOLDER_REFERENCE
public static final String PART_FOLDER
public static final String PART_FOLDER_REFERENCE
public static final String TEAM_TEMPLATE
public static final String TEAM_TEMPLATE_REFERENCE
public static final String VIEW
public static final String VIEW_REFERENCE
public static final String CONTAINER
public static final String CONTAINER_REFERENCE
| Method Detail |
|---|
public String getName()
public void setName(String a_Name)
throws WTPropertyVetoException
a_Name -
WTPropertyVetoExceptionpublic File getDirectory()
public void setDirectory(File a_Directory)
throws WTPropertyVetoException
a_Directory -
WTPropertyVetoExceptionpublic String getDescription()
public void setDescription(String a_Description)
throws WTPropertyVetoException
a_Description -
WTPropertyVetoExceptionpublic boolean isPartCentricProcessing()
public void setPartCentricProcessing(boolean a_PartCentricProcessing)
throws WTPropertyVetoException
a_PartCentricProcessing -
WTPropertyVetoExceptionpublic boolean isViewExplicitlySet()
public void setViewExplicitlySet(boolean a_ViewExplicitlySet)
throws WTPropertyVetoException
a_ViewExplicitlySet -
WTPropertyVetoExceptionpublic Folder getFolder()
public void setFolder(Folder a_Folder)
throws WTPropertyVetoException,
WTException
a_Folder -
WTPropertyVetoException
WTExceptionpublic ObjectReference getFolderReference()
public void setFolderReference(ObjectReference a_FolderReference)
throws WTPropertyVetoException
a_FolderReference -
WTPropertyVetoExceptionpublic WTPartConfigSpec getPartConfigSpec()
public void setPartConfigSpec(WTPartConfigSpec a_PartConfigSpec)
throws WTPropertyVetoException,
WTException
a_PartConfigSpec -
WTPropertyVetoException
WTExceptionpublic ObjectReference getPartConfigSpecReference()
public void setPartConfigSpecReference(ObjectReference a_PartConfigSpecReference)
throws WTPropertyVetoException
a_PartConfigSpecReference -
WTPropertyVetoExceptionpublic EPMDocConfigSpec getDocConfigSpec()
public void setDocConfigSpec(EPMDocConfigSpec a_DocConfigSpec)
throws WTPropertyVetoException,
WTException
a_DocConfigSpec -
WTPropertyVetoException
WTExceptionpublic ObjectReference getDocConfigSpecReference()
public void setDocConfigSpecReference(ObjectReference a_DocConfigSpecReference)
throws WTPropertyVetoException
a_DocConfigSpecReference -
WTPropertyVetoExceptionpublic WTPrincipalReference getPrincipalReference()
public void setPrincipalReference(WTPrincipalReference a_PrincipalReference)
throws WTPropertyVetoException
a_PrincipalReference -
WTPropertyVetoExceptionpublic wt.lifecycle.LifeCycleTemplateMaster getDocLifeCycle()
public void setDocLifeCycle(wt.lifecycle.LifeCycleTemplateMaster a_DocLifeCycle)
throws WTPropertyVetoException,
WTException
a_DocLifeCycle -
WTPropertyVetoException
WTExceptionpublic ObjectReference getDocLifeCycleReference()
public void setDocLifeCycleReference(ObjectReference a_DocLifeCycleReference)
throws WTPropertyVetoException
a_DocLifeCycleReference -
WTPropertyVetoExceptionpublic wt.lifecycle.LifeCycleTemplateMaster getPartLifeCycle()
public void setPartLifeCycle(wt.lifecycle.LifeCycleTemplateMaster a_PartLifeCycle)
throws WTPropertyVetoException,
WTException
a_PartLifeCycle -
WTPropertyVetoException
WTExceptionpublic ObjectReference getPartLifeCycleReference()
public void setPartLifeCycleReference(ObjectReference a_PartLifeCycleReference)
throws WTPropertyVetoException
a_PartLifeCycleReference -
WTPropertyVetoExceptionpublic Folder getDocFolder()
public void setDocFolder(Folder a_DocFolder)
throws WTPropertyVetoException,
WTException
a_DocFolder -
WTPropertyVetoException
WTExceptionpublic ObjectReference getDocFolderReference()
public void setDocFolderReference(ObjectReference a_DocFolderReference)
throws WTPropertyVetoException
a_DocFolderReference -
WTPropertyVetoExceptionpublic Folder getPartFolder()
public void setPartFolder(Folder a_PartFolder)
throws WTPropertyVetoException,
WTException
a_PartFolder -
WTPropertyVetoException
WTExceptionpublic ObjectReference getPartFolderReference()
public void setPartFolderReference(ObjectReference a_PartFolderReference)
throws WTPropertyVetoException
a_PartFolderReference -
WTPropertyVetoExceptionpublic wt.team.TeamTemplate getTeamTemplate()
public void setTeamTemplate(wt.team.TeamTemplate a_TeamTemplate)
throws WTPropertyVetoException,
WTException
a_TeamTemplate -
WTPropertyVetoException
WTExceptionpublic ObjectReference getTeamTemplateReference()
public void setTeamTemplateReference(ObjectReference a_TeamTemplateReference)
throws WTPropertyVetoException
a_TeamTemplateReference -
WTPropertyVetoExceptionpublic View getView()
public void setView(View a_View)
throws WTPropertyVetoException,
WTException
a_View -
WTPropertyVetoException
WTExceptionpublic ObjectReference getViewReference()
public void setViewReference(ObjectReference a_ViewReference)
throws WTPropertyVetoException
a_ViewReference -
WTPropertyVetoExceptionpublic WTContainer getContainer()
public void setContainer(WTContainer a_Container)
throws WTPropertyVetoException,
WTException
a_Container -
WTPropertyVetoException
WTExceptionpublic ObjectReference getContainerReference()
public void setContainerReference(ObjectReference a_ContainerReference)
throws WTPropertyVetoException
a_ContainerReference -
WTPropertyVetoException
public static EPMWorkspace newEPMWorkspace(String name,
WTPrincipal principal,
Folder folder,
WTPartConfigSpec partConfigSpec,
EPMDocConfigSpec docConfigSpec,
WTContainer container)
throws WTException
name - principal - folder - If null,then a folder is created in the users's personal cabinet with same name as the workspace name.partConfigSpec - docConfigSpec - container - WTContainer for new objects created in EPMWorkspace
WTException
protected void initialize(String name,
WTPrincipal principal,
Folder folder,
WTPartConfigSpec partConfigSpec,
EPMDocConfigSpec docConfigSpec,
WTContainer container)
throws WTException
name - principal - folder - If null,then a folder is created in the users's personal cabinet with same name as the workspace name.partConfigSpec - docConfigSpec - container - WTContainer for new objects created in EPMWorkspace
WTException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||