Package wt.epm.workspaces

Class EPMWorkspace

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.epm.workspaces._EPMWorkspace

wt.epm.workspaces.EPMWorkspace

All Implemented Interfaces:

Externalizable, Serializable, wt.epm.supportingdata._EPMSupportingDataHolder, EPMSupportingDataHolder, wt.fc._Identified, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc._UniquelyIdentified, Identified, NetFactor, ObjectMappable, Persistable, UniquelyIdentified, wt.filter._NavigationCriteriaOwner, wt.filter.NavigationCriteriaOwner, DisplayIdentification, wt.recent.RecentlyVisited

@GenAsPersistable(superClass=WTObject.class,interfaces={EPMSupportingDataHolder.class,UniquelyIdentified.class,wt.recent.RecentlyVisited.class,wt.filter.NavigationCriteriaOwner.class},versions=3402811862776974917L,properties={@GeneratedProperty(name="name",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="The name of the EPMWorkspace.",constraints=@PropertyConstraints(changeable=VIA_OTHER_MEANS)),@GeneratedProperty(name="directory",type=java.io.File.class,supportedAPI=PUBLIC,javaDoc="The directory in which Checked Out files associated with the EPMWorkspace are stored.",columnProperties=@ColumnProperties(columnType=BLOB)),@GeneratedProperty(name="initialCheckpoint",type=wt.epm.workspaces.EPMCheckpoint.class,supportedAPI=PRIVATE,javaDoc="The initial Checkpoint for the Workspace. Used in the persistence listener to persist the checkpoint along with the Workspace.",accessors=@PropertyAccessors(getAccess=PROTECTED,setAccess=PRIVATE),columnProperties=@ColumnProperties(persistent=false)),@GeneratedProperty(name="description",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="A description of the workspace."),@GeneratedProperty(name="partCentricProcessing",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="true/false flag to indicate if primary dependency processing is to be done on PartCentric mode."),@GeneratedProperty(name="activeClientCache",type=java.lang.String.class,javaDoc="Identifies the client cache on the user\'s local machine that is currently active.",constraints=@PropertyConstraints(changeable=VIA_OTHER_MEANS)),@GeneratedProperty(name="viewExplicitlySet",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="true/false flag to indicate if the view reference has been set by the client"),@GeneratedProperty(name="transparent",type=boolean.class,initialValue="false",javaDoc="If this attribute is set to true, the workspace will be transparent. Default value is False",accessors=@PropertyAccessors(setAccess=PRIVATE),columnProperties=@ColumnProperties(defaultValue="0")),@GeneratedProperty(name="principalReference",type=WTPrincipalReference.class,supportedAPI=PUBLIC,constraints=@PropertyConstraints(changeable=VIA_OTHER_MEANS,required=true),columnProperties=@ColumnProperties(columnName="M")),@GeneratedProperty(name="populateRule",type=EPMPopulateRule.class,supportedAPI=DEPRECATED,constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="partNavigationCriteria",type=NavigationCriteria.class,supportedAPI=PRIVATE,javaDoc="The WTPart Navigation Criteria for the Workspace.",accessors=@PropertyAccessors(getAccess=PUBLIC,setAccess=PUBLIC),constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(persistent=false)),@GeneratedProperty(name="docNavigationCriteria",type=NavigationCriteria.class,supportedAPI=PRIVATE,javaDoc="The EPMDoc Navigation Criteria for the Workspace.",accessors=@PropertyAccessors(getAccess=PUBLIC,setAccess=PUBLIC),constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(persistent=false)),@GeneratedProperty(name="disableCSChangeTracking",type=boolean.class,initialValue="false",javaDoc="If this attribute is set to true, commonspace change tracking for the workspace will be disabled. Default value is False",constraints=@PropertyConstraints(changeable=FROZEN),columnProperties=@ColumnProperties(defaultValue="0"))},foreignKeys={@GeneratedForeignKey(name="Checkpoint",foreignKeyRole=@ForeignKeyRole(name="theEPMCheckpointMaster",type=wt.epm.workspaces.EPMCheckpointMaster.class,supportedAPI=DEPRECATED,constraints=@PropertyConstraints(required=true),accessors=@PropertyAccessors(getAccess=PROTECTED)),myRole=@MyRole(name="theEPMWorkspace",cardinality=ONE,supportedAPI=DEPRECATED,accessors=@PropertyAccessors(getAccess=PROTECTED))),@GeneratedForeignKey(name="WorkspaceFolder",foreignKeyRole=@ForeignKeyRole(name="folder",type=Folder.class,supportedAPI=PUBLIC,constraints=@PropertyConstraints(required=true)),myRole=@MyRole(name="workspace",cardinality=ONE)),@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="docLifeCycle",type=LifeCycleTemplateMaster.class,supportedAPI=PUBLIC,columnProperties=@ColumnProperties(columnName="E")),myRole=@MyRole(name="workspace")),@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="partLifeCycle",type=LifeCycleTemplateMaster.class,supportedAPI=PUBLIC,columnProperties=@ColumnProperties(columnName="F")),myRole=@MyRole(name="workspace")),@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="docFolder",type=Folder.class,supportedAPI=PUBLIC,columnProperties=@ColumnProperties(columnName="G")),myRole=@MyRole(name="workspace")),@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="partFolder",type=Folder.class,supportedAPI=PUBLIC,columnProperties=@ColumnProperties(columnName="H")),myRole=@MyRole(name="workspace")),@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="teamTemplate",type=TeamTemplate.class,supportedAPI=PUBLIC,columnProperties=@ColumnProperties(columnName="I")),myRole=@MyRole(name="workspace")),@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="view",type=View.class,supportedAPI=PUBLIC,columnProperties=@ColumnProperties(columnName="J"),javaDoc="View to be used for new WTParts in EPMWorkspace"),myRole=@MyRole(name="workspace")),@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="container",type=WTContainer.class,supportedAPI=PUBLIC,constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(columnName="K"),javaDoc="WTContainer to be used for new objects in EPMWorkspace. If this is ClassicContainer or ProjectContainer,  this value cannot  be changed once EPMWorkspace is persisted.  If this is PDMLinkContainer, value can be changed to another valid PDMLinkContainer."),myRole=@MyRole(name="workspace")),@GeneratedForeignKey(name="WorkspaceCheckpoint",foreignKeyRole=@ForeignKeyRole(name="checkpoint",type=wt.epm.workspaces.EPMCheckpoint.class,supportedAPI=PRIVATE,owner=false,cascade=true,constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(columnName="L")),myRole=@MyRole(name="workspace",cardinality=ONE,supportedAPI=PRIVATE))},tableProperties=@TableProperties(compositeIndex1="+folderReference.key.id",compositeIndex2="+checkpointReference.key.id",compositeIndex3="+principalReference.key.id+containerReference.key.id",compositeIndex4="+name+principalReference.key.id",compositeIndex5="+partFolderReference.key.classname+partFolderReference.key.id+thePersistInfo.theObjectIdentifier.id",compositeIndex6="+docFolderReference.key.classname+docFolderReference.key.id+thePersistInfo.theObjectIdentifier.id"))
public class EPMWorkspace
extends _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

See Also:

• Serialized Form

Field Summary

Fields inherited from class wt.epm.workspaces._EPMWorkspace

CONTAINER, CONTAINER_REFERENCE, DESCRIPTION, DIRECTORY, DOC_FOLDER, DOC_FOLDER_REFERENCE, DOC_LIFE_CYCLE, DOC_LIFE_CYCLE_REFERENCE, FOLDER, FOLDER_REFERENCE, NAME, PART_CENTRIC_PROCESSING, PART_FOLDER, PART_FOLDER_REFERENCE, PART_LIFE_CYCLE, PART_LIFE_CYCLE_REFERENCE, PRINCIPAL_REFERENCE, TEAM_TEMPLATE, TEAM_TEMPLATE_REFERENCE, VIEW, VIEW_EXPLICITLY_SET, VIEW_REFERENCE

Method Summary

Modifier and Type	Method	Description
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.
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.
protected void	initialize(String name, WTPrincipal principal, Folder folder, WTPartConfigSpec partConfigSpec, EPMDocConfigSpec docConfigSpec, WTContainer container)	Supports initialization, following construction of an instance.
static EPMWorkspace	newEPMWorkspace(String name, WTPrincipal principal, Folder folder, WTPartConfigSpec partConfigSpec, EPMDocConfigSpec docConfigSpec, WTContainer container)	Supported API: true This API will be replaced in future by a NavigationCriteria-based API.
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	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	setViewReference(ObjectReference a_ViewReference)	Sets the value of the attribute: VIEW_REFERENCE.

Methods inherited from class wt.epm.workspaces._EPMWorkspace

getContainer, getContainerReference, getDescription, getDirectory, getDocFolder, getDocFolderReference, getDocLifeCycle, getDocLifeCycleReference, getFolder, getFolderReference, getName, getPartFolder, getPartFolderReference, getPartLifeCycle, getPartLifeCycleReference, getPrincipalReference, getTeamTemplate, getTeamTemplateReference, getView, getViewReference, isPartCentricProcessing, isViewExplicitlySet, setContainer, setDocFolder, setDocFolderReference, setDocLifeCycle, setDocLifeCycleReference, setFolder, setFolderReference, setName, setPartCentricProcessing, setPartFolder, setPartFolderReference, setPartLifeCycle, setPartLifeCycleReference, setPrincipalReference, setTeamTemplate, setTeamTemplateReference, setView, setViewExplicitlySet

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

Methods inherited from interface wt.fc.Persistable

checkAttributes

Method Details

setDirectory

public void setDirectory(File a_Directory)
                  throws WTPropertyVetoException

Sets the value of the attribute: DIRECTORY. The directory in which Checked Out files associated with the EPMWorkspace are stored.

Supported API: true

Overrides:

setDirectory in class _EPMWorkspace

Parameters:

a_Directory -

Throws:

WTPropertyVetoException

See Also:

• EPMWorkspace

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. A description of the workspace.

Supported API: true

Overrides:

setDescription in class _EPMWorkspace

Parameters:

a_Description -

Throws:

WTPropertyVetoException

See Also:

• EPMWorkspace

setViewReference

public void setViewReference(ObjectReference a_ViewReference)
                      throws WTPropertyVetoException

Sets the value of the attribute: VIEW_REFERENCE. View to be used for new WTParts in EPMWorkspace

Supported API: true

Overrides:

setViewReference in class _EPMWorkspace

Parameters:

a_ViewReference -

Throws:

WTPropertyVetoException

See Also:

• EPMWorkspace

setContainerReference

public void setContainerReference(ObjectReference a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE. WTContainer to be used for new objects in EPMWorkspace. If this is ClassicContainer or ProjectContainer, this value cannot be changed once EPMWorkspace is persisted. If this is PDMLinkContainer, value can be changed to another valid PDMLinkContainer.

Supported API: true

Overrides:

setContainerReference in class _EPMWorkspace

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

See Also:

• EPMWorkspace

newEPMWorkspace

public static EPMWorkspace newEPMWorkspace(String name,
 WTPrincipal principal,
 Folder folder,
 WTPartConfigSpec partConfigSpec,
 EPMDocConfigSpec docConfigSpec,
 WTContainer container)
                                    throws WTException

Supported API: true This API will be replaced in future by a NavigationCriteria-based API.

Parameters:

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

Returns:

EPMWorkspace

Throws:

WTException

initialize

protected void initialize(String name,
 WTPrincipal principal,
 Folder folder,
 WTPartConfigSpec partConfigSpec,
 EPMDocConfigSpec docConfigSpec,
 WTContainer container)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true This API will be replaced in future by a NavigationCriteria-based API.

Parameters:

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

Throws:

WTException

getPartConfigSpec

public WTPartConfigSpec getPartConfigSpec()

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

Supported API: true This API will be replaced in future by a NavigationCriteria-based API.

Returns:

WTPartConfigSpec

setPartConfigSpec

public void setPartConfigSpec(WTPartConfigSpec a_PartConfigSpec)
                       throws WTPropertyVetoException,
WTException

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

Supported API: true This API will be replaced in future by a NavigationCriteria-based API.

Parameters:

a_PartConfigSpec -

Throws:

WTPropertyVetoException

WTException

getPartConfigSpecReference

public ObjectReference getPartConfigSpecReference()

Gets the value of the attribute: PART_CONFIG_SPEC_REFERENCE.

Supported API: true This API will be replaced in future by a NavigationCriteria-based API.

Returns:

ObjectReference

getDocConfigSpec

public EPMDocConfigSpec getDocConfigSpec()

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

Supported API: true This API will be replaced in future by a NavigationCriteria-based API.

Returns:

EPMDocConfigSpec

getDocConfigSpecReference

public ObjectReference getDocConfigSpecReference()

Gets the value of the attribute: DOC_CONFIG_SPEC_REFERENCE.

Supported API: true This API will be replaced in future by a NavigationCriteria-based API.

Returns:

ObjectReference

setDocConfigSpec

public void setDocConfigSpec(EPMDocConfigSpec a_DocConfigSpec)
                      throws WTPropertyVetoException,
WTException

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

Supported API: true This API will be replaced in future by a NavigationCriteria-based API.

Parameters:

a_DocConfigSpec -

Throws:

WTPropertyVetoException

WTException

setDocConfigSpecReference

public void setDocConfigSpecReference(ObjectReference a_DocConfigSpecReference)
                               throws WTPropertyVetoException

Sets the value of the attribute: DOC_CONFIG_SPEC_REFERENCE.

Supported API: true This API will be replaced in future by a NavigationCriteria-based API.

Parameters:

a_DocConfigSpecReference -

Throws:

WTPropertyVetoException

setPartConfigSpecReference

public void setPartConfigSpecReference(ObjectReference a_PartConfigSpecReference)
                                throws WTPropertyVetoException

Sets the value of the attribute: PART_CONFIG_SPEC_REFERENCE.

Supported API: true This API will be replaced in future by a NavigationCriteria-based API.

Parameters:

a_PartConfigSpecReference -

Throws:

WTPropertyVetoException