CIP JavaScript documentation for class " pfcServerLocation"

Class pfcServerLocation

Description

This class describes server location.

Direct Parent Classes:: pfcChild

Direct Known Subclasses:: pfcNonRegisteredServer, pfcServer

Property Summary


`/* readonly */ string`	`Class`
	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.

`/* readonly */ string`	`Location`
	Specifies the codebase URL .

`/* readonly */ string`	`Version`
	Specifies the version of Windchill that is configured on the server, for example, "7.0" or "8.0."

Method Summary


`pfcWorkspaceDefinitions`	`CollectWorkspaces ()`
	Gets the list of the workspaces .

`void`	`DeleteWorkspace (string WorkspaceName)`
	Deletes a workspace.

`stringseq`	`ListContexts ()`
	Gets the list of the contexts

Property Detail

/* readonly */ string Class

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.

/* readonly */ string Location

Specifies the codebase URL .

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The server was not registered.

/* readonly */ string Version

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

Method Detail

pfcWorkspaceDefinitions 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

Returns:: Sequence of pfcWorkspaceDefinitions objects

void DeleteWorkspace (string WorkspaceName)

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:: pfcXToolkitCheckoutConflict

Parameters:

WorkspaceName: The workspace name.

stringseq 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

Returns:: Sequence of context strings