CIP JAVA documentation for class "com.ptc.pfc.pfcServer.ServerLocation"

Interface ServerLocation

package com.ptc.pfc.pfcServer; public interface ServerLocation extends com.ptc.pfc.pfcObject.Child

Description

This class describes server location.

Direct Known Subclasses:: NonRegisteredServer, Server

Method Summary
`WorkspaceDefinitions`	`CollectWorkspaces ()` Gets the list of the workspaces .
`void`	`DeleteWorkspace (String WorkspaceName)` Deletes a workspace.
`String`	`GetClass ()` Get method for attribute "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.
`String`	`GetLocation ()` Get method for attribute "Location" Specifies the codebase URL .
`String`	`GetVersion ()` Get method for attribute "Version" Specifies the version of Windchill that is configured on the server, for example, "7.0" or "8.0."
`stringseq`	`ListContexts ()` Gets the list of the contexts

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Method Detail

GetLocation

String GetLocation ()

Specifies the codebase URL .

Exceptions thrown (but not limited to):

XToolkitNotFound - The server was not registered.

Manual References:: Windchill Connectivity APIs: Accessing Information Before Registering a Server, Windchill Connectivity APIs: Accessing Information Before Registering a Server

GetVersion

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

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

XToolkitUnsupported - The server is not a Windchill server

Manual References:: Windchill Connectivity APIs: Accessing Information Before Registering a Server, Windchill Connectivity APIs: Accessing Information Before Registering a Server

GetClass

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

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

Manual References:: Windchill Connectivity APIs: Accessing Information Before Registering a Server, Windchill Connectivity APIs: Accessing Information Before Registering a Server

CollectWorkspaces

WorkspaceDefinitions CollectWorkspaces ()

Gets the list of the workspaces .

Exceptions thrown (but not limited to):

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

XToolkitEmpty - The server does not have any workspaces

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

XToolkitInvalidType - The server version is not supported

Manual References:: Windchill Connectivity APIs: Accessing Information Before Registering a Server, Windchill Connectivity APIs: Accessing Workspaces, Windchill Connectivity APIs: To Register a Server with an Existing Workspace

Returns:: Sequence of WorkspaceDefinitions objects

DeleteWorkspace

void DeleteWorkspace (String WorkspaceName)

Deletes a workspace.

Exceptions thrown (but not limited to):

XToolkitNotFound - The server is not registered.

XToolkitInvalidDir - The workspace does not exist.

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

XToolkitInUse - The workspace is active

See Also:: XToolkitCheckoutConflict

Manual References:: Windchill Connectivity APIs: Creating and Modifying the Workspace

Parameters:

WorkspaceName: The workspace name.

Returns:

ListContexts

stringseq ListContexts ()

Gets the list of the contexts

Exceptions thrown (but not limited to):

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

XToolkitEmpty - The server does not have any contexts.

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

XToolkitInvalidType - The server version is not supported

Manual References:: Windchill Connectivity APIs: Accessing Information Before Registering a Server, Windchill Connectivity APIs: Accessing Information Before Registering a Server, Windchill Connectivity APIs: To Register a Server with a New Workspace

Returns:: Sequence of context strings