Class pfcServerLocation
# include <pfcServer.h>
class pfcServerLocation
: public virtual pfcChild
{
xaideclare(pfcServerLocation)
...
};
Description
This class describes server location.
Direct Known Subclasses:
Methods Inherited from Class pfcChild::
Method Summary
Gets the list of the workspaces . | |
void | |
Deletes a workspace. | |
GetClass () | |
Specifies the class of the server . The values of the server class are "Windchill" and "ProjectLink." "Windchill" denotes either a Windchill Classic PDM or a Windchill PDMLink server, while "ProjectLink" denotes Windchill ProjectLink type of servers. | |
GetLocation () | |
Specifies the codebase URL . | |
GetVersion () | |
Specifies the version of Windchill that is configured on the server, for example, "7.0" or "8.0." | |
ListContexts () | |
Gets the list of the contexts |
Method Detail
GetLocation | () |
Specifies the codebase URL .
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The server was not registered.
User Guide References:
GetVersion | () |
Specifies the version of Windchill that is configured on the server, for example, "7.0" or "8.0."
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The server couldn't be found at the given location.
pfcXToolkitUnsupported - The server is not a Windchill server
User Guide References:
GetClass | () |
Specifies the class of the server . The values of the server class are "Windchill" and "ProjectLink." "Windchill" denotes either a Windchill Classic PDM or a Windchill PDMLink server, while "ProjectLink" denotes Windchill ProjectLink type of servers.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The server couldn't be found at the given location.
User Guide References:
CollectWorkspaces | () |
Gets the list of the workspaces .
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - This means either:
• No context was found (the server was from WC 6.2.6), OR
• The server was not registered or couldn't be found at the given location.
pfcXToolkitEmpty - The server does not have any workspaces
pfcXToolkitCantAccess - Server communication error, or user lacks permission to view workspaces on this server.
pfcXToolkitInvalidType - The server version is not supported
User Guide References:
Returns:
Sequence of pfcWorkspaceDefinitions objects
void | DeleteWorkspace |
Deletes a workspace.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The server is not registered.
pfcXToolkitInvalidDir - The workspace does not exist.
pfcXToolkitCheckoutConflict - The workspace cannot be deleted due to checked out objects in its contents.
pfcXToolkitInUse - The workspace is active
See Also:
User Guide References:
Parameters:
WorkspaceName
The workspace name.
Returns:
ListContexts | () |
Gets the list of the contexts
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The server was not registered or couldn't be found at the given location.
pfcXToolkitEmpty - The server does not have any contexts.
pfcXToolkitCantAccess - Server communication error, or user lacks permission to view workspaces on this server.
pfcXToolkitInvalidType - The server version is not supported
User Guide References:
Returns:
Sequence of context strings