CIP Visual Basic.NET documentation for interface "IpfcServerLocation"

Interface IpfcServerLocation

Description

This class describes server location.

Direct Parent Classes:: IpfcChild

Direct Known Subclasses:: IpfcNonRegisteredServer, IpfcServer

Property Summary


`Property`	`Class`	`as String`
	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.

`Property`	`Location`	`as String`
	Specifies the codebase URL .

`Property`	`Version`	`as String`
	Specifies the version of Windchill that is configured on the server, for example, "7.0" or "8.0."

Method Summary


`Function`	`CollectWorkspaces () as IpfcWorkspaceDefinitions`
	Gets the list of the workspaces .

`Sub`	`DeleteWorkspace (WorkspaceName as String)`
	Deletes a workspace.

`Function`	`ListContexts () as Istringseq`
	Gets the list of the contexts

Property Detail

Property Class as String

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

IpfcXToolkitNotFound - The server couldn't be found at the given location.

Property Location as String

Specifies the codebase URL .

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The server was not registered.

Property Version as String

Specifies the version of Windchill that is configured on the server, for example, "7.0" or "8.0."

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The server couldn't be found at the given location.

IpfcXToolkitUnsupported - The server is not a Windchill server

Method Detail

Function CollectWorkspaces () as IpfcWorkspaceDefinitions

Gets the list of the workspaces .

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - 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.

IpfcXToolkitEmpty - The server does not have any workspaces

IpfcXToolkitCantAccess - Server communication error, or user lacks permission to view workspaces on this server.

IpfcXToolkitInvalidType - The server version is not supported

Returns:: Sequence of IpfcWorkspaceDefinitions objects

Sub DeleteWorkspace (WorkspaceName as String)

Deletes a workspace.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The server is not registered.

IpfcXToolkitInvalidDir - The workspace does not exist.

IpfcXToolkitCheckoutConflict - The workspace cannot be deleted due to checked out objects in its contents.

IpfcXToolkitInUse - The workspace is active

See Also:: IpfcXToolkitCheckoutConflict

Parameters:

WorkspaceName: The workspace name.

Function ListContexts () as Istringseq

Gets the list of the contexts

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The server was not registered or couldn't be found at the given location.

IpfcXToolkitEmpty - The server does not have any contexts.

IpfcXToolkitCantAccess - Server communication error, or user lacks permission to view workspaces on this server.

IpfcXToolkitInvalidType - The server version is not supported

Returns:: Sequence of context strings