com.ptc.windchill.cadx.ws
Class WorkspaceHelper

java.lang.Object
  com.ptc.windchill.cadx.ws.WorkspaceHelper

public class WorkspaceHelper

extends Object

Field Summary

private static String	CODEBASE
private static String	GENERAL_DELIM_STRING
private static boolean	VERBOSE
private static String	WORKSPACE_IMG
private static String	WORKSPACE_IMGTAG
private static String	WORKSPACE_OBJ_CHECKED_OUT
private static String	WORKSPACE_OBJ_DEFAULT
private static String	WORKSPACE_OBJ_SHORTCUT
private static String	WORKSPACE_OBJ_WORKING_COPY

Constructor Summary

WorkspaceHelper()

Method Summary

static String	getActiveWorkspaceName(HTTPState https)
private static Workable	getSharedRefreshCandidate(WTContainer container, Workable obj)
private static Map	getSharedRefreshCandidatesMap(WTContainer container)
static String	getVersionDisplay(Iterated iteration, Locale locale) Returns the string representing the version identifier to be displayed in the UI.
static EPMWorkspace	getWorkspace(String name)
static String	getWorkspaceContentState(CabinetBased obj, EPMWorkspace ws)
static String	getWorkspaceContentState(CabinetBased obj, EPMWorkspace ws, boolean isActiveWs)
static String	getWorkspaceContentState(CabinetBased obj, EPMWorkspace ws, boolean isActiveWs, boolean isLatestIterationComputed, Iterated latestIteration, Boolean isNewObject)
static String	getWorkspaceContentState(CabinetBased obj, WTContainer context)
static String	getWorkspaceIcon()
static String	getWorkspaceIconImgTag()
static boolean	isActiveWorkspace(String ws_name, HTTPState https)
static boolean	isFolderEPMWorkspace(Object obj)
static boolean	isNewDocument(EPMDocument document)
static boolean	isNewPart(WTPart part)
static SortedEnumeration	retrieveWorkspaceContents(EPMWorkspace ws) Retrieve the Workspace contents of the specified Workspace object.
static boolean	workspaceAlreadyExists(String name, WTPrincipal principal)

Methods inherited from class java.lang.Object

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

Field Detail

VERBOSE

private static boolean VERBOSE

CODEBASE

private static String CODEBASE

WORKSPACE_IMG

private static String WORKSPACE_IMG

WORKSPACE_IMGTAG

private static String WORKSPACE_IMGTAG

WORKSPACE_OBJ_DEFAULT

private static final String WORKSPACE_OBJ_DEFAULT

See Also:

Constant Field Values

WORKSPACE_OBJ_SHORTCUT

private static final String WORKSPACE_OBJ_SHORTCUT

See Also:

Constant Field Values

WORKSPACE_OBJ_WORKING_COPY

private static final String WORKSPACE_OBJ_WORKING_COPY

See Also:

Constant Field Values

WORKSPACE_OBJ_CHECKED_OUT

private static final String WORKSPACE_OBJ_CHECKED_OUT

See Also:

Constant Field Values

GENERAL_DELIM_STRING

private static final String GENERAL_DELIM_STRING

See Also:

Constant Field Values

Constructor Detail

WorkspaceHelper

public WorkspaceHelper()

Method Detail

getWorkspaceIcon

public static String getWorkspaceIcon()

getWorkspaceIconImgTag

public static String getWorkspaceIconImgTag()

getWorkspaceContentState

public static String getWorkspaceContentState(CabinetBased obj,
                                              WTContainer context)

getWorkspaceContentState

public static String getWorkspaceContentState(CabinetBased obj,
                                              EPMWorkspace ws)

getWorkspaceContentState

public static String getWorkspaceContentState(CabinetBased obj,
                                              EPMWorkspace ws,
                                              boolean isActiveWs)

getWorkspaceContentState

public static String getWorkspaceContentState(CabinetBased obj,
                                              EPMWorkspace ws,
                                              boolean isActiveWs,
                                              boolean isLatestIterationComputed,
                                              Iterated latestIteration,
                                              Boolean isNewObject)

isNewDocument

public static boolean isNewDocument(EPMDocument document)
                             throws WTException

Throws:

WTException

workspaceAlreadyExists

public static boolean workspaceAlreadyExists(String name,
                                             WTPrincipal principal)
                                      throws WTException

Throws:

WTException

getWorkspace

public static EPMWorkspace getWorkspace(String name)
                                 throws WTException

Throws:

WTException

isFolderEPMWorkspace

public static boolean isFolderEPMWorkspace(Object obj)

retrieveWorkspaceContents

public static SortedEnumeration retrieveWorkspaceContents(EPMWorkspace ws)
                                                   throws WTException

Retrieve the Workspace contents of the specified Workspace object.

Supported API: false

Returns:

a SortedEnumeration of the contents associated with the Workspace object.

Throws:

WTException

isActiveWorkspace

public static boolean isActiveWorkspace(String ws_name,
                                        HTTPState https)
                                 throws WTException

Throws:

WTException

getActiveWorkspaceName

public static String getActiveWorkspaceName(HTTPState https)

isNewPart

public static boolean isNewPart(WTPart part)
                         throws WTException

Throws:

WTException

getVersionDisplay

public static String getVersionDisplay(Iterated iteration,
                                       Locale locale)

Returns the string representing the version identifier to be displayed in the UI. The string is of the form A.1, A-1.1, or 1 depending on whether the object is Versioned, OneOffVersioned, or Iterated.

Parameters:

iteration -

Returns:

String

getSharedRefreshCandidate

private static Workable getSharedRefreshCandidate(WTContainer container,
                                                  Workable obj)
                                           throws WTException

Throws:

WTException

getSharedRefreshCandidatesMap

private static Map getSharedRefreshCandidatesMap(WTContainer container)
                                          throws WTException

Throws:

WTException