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

Interface Server

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

Description

This class describes server

Method Summary
`void`	`Activate ()` Sets the server to be active in session.
`void`	`CheckinObjects ( /optional/ Model Mdl, /optional/ CheckinOptions Options)` Checks in an object to the database.
`stringseq`	`CheckoutMultipleObjects (stringseq Files, boolean Checkout, /optional/ CheckoutOptions Options)` Checks out or downloads multiple objects to the workspace. Checkout rules are processed based on the Workspace config spec, unless the version is set using `CheckoutOptions.GetVersion(/optional/ String)`. If the config spec is LATEST, for example, the latest version of the indicated object(s) will be checked out. If an aliased URL path to a model is supplied, and more than one revision of the model is in the path, Creo Parametric will apply the workspace config spec rules against the objects which reside in that folder.
`String`	`CheckoutObjects ( /optional/ Model Mdl, /optional/ String File, boolean Checkout, /optional/ CheckoutOptions Options)` Checks out or downloads an object to the workspace. Checkout rules are processed based on the Workspace config spec, unless the version is set using `CheckoutOptions.GetVersion(/optional/ String)`. If the config spec is LATEST, for example, the latest version of the indicated object(s) will be checked out. If an aliased URL path to the model is supplied, and more than one revision of the model is in the path, Creo Parametric will apply the workspace config spec rules against the objects which reside in that folder.
`void`	`CreateWorkspace (WorkspaceDefinition Definition)` Creates and activates a new workspace.
`String`	`GetActiveWorkspace ()` Get method for attribute "ActiveWorkspace" Specifies the name of active server.
`String`	`GetAlias ()` Get method for attribute "Alias" Specifies the alias of server.
`String`	`GetAliasedUrl (String ModelName)` Gets aliased url for a given model name.
`String`	`GetContext ()` Get method for attribute "Context" Specifies context of the server
`boolean`	`GetIsActive ()` Get method for attribute "IsActive" Specifies whether server active or not.
`boolean`	`IsObjectCheckedOut (String WorkspaceName, String ObjectName)` Returns the checkout status for the given object in the workspace.
`boolean`	`IsObjectModified (String WorkspaceName, String ObjectName)` Returns the modification status for the given object in the workspace.
`ServerObjectStatus`	`IsServerObjectModified (String WorkspaceName, String ObjectName)` Checks if the given object is modified in workspace or modified locally.
`void`	`RemoveObjects ( /optional/ stringseq ModelNames)` Removes a list of models from a workspace.
`void`	`SetActiveWorkspace (String value)` Set method for attribute "ActiveWorkspace" Specifies the name of active server.
`void`	`UndoCheckout (Model Mdl)` Undoes the checkout of the given object.
`void`	`Unregister ()` Unregisters a given server and cleans a local cache for the server.
`void`	`UploadObjects (Model Mdl)` Uploads an object to the database.
`void`	`UploadObjectsWithOptions ( /optional/ Model TopModel, UploadOptions Options)` Uploads objects to the database with the specified options.

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

Methods Inherited from Interface `com.ptc.pfc.pfcServer.ServerLocation`
`GetLocation`, `GetVersion`, `GetClass`, `CollectWorkspaces`, `DeleteWorkspace`, `ListContexts`

Method Detail

GetAlias

String GetAlias ()

Specifies the alias of server.

Manual References:: Windchill Connectivity APIs: Accessing Information From a Registered Server, Windchill Connectivity APIs: Accessing Information From a Registered Server

GetActiveWorkspace/SetActiveWorkspace

`String`	`GetActiveWorkspace`	`()`
`void`	`SetActiveWorkspace`	`(String value)`

Specifies the name of active server.

Exceptions thrown (but not limited to):

XToolkitNotFound - The server was not registered.

XToolkitInvalidDir - The workspace couldn't be found or created.

XToolkitFound - The workspace is already set.

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

GetIsActive

boolean GetIsActive ()

Specifies whether server active or not.

Exceptions thrown (but not limited to):

XToolkitNotFound - There is no active aliased server (Local Dir is active).

Manual References:: Windchill Connectivity APIs: Accessing Information From a Registered Server, Windchill Connectivity APIs: Accessing Information From a Registered Server

GetContext

String GetContext ()

Specifies context of the server

Exceptions thrown (but not limited to):

XToolkitNotFound - The server was not registered.

Manual References:: Windchill Connectivity APIs: Accessing Information From a Registered Server

Unregister

void Unregister ()

Unregisters a given server and cleans a local cache for the server.

Exceptions thrown (but not limited to):

XToolkitNotFound - The server is not registered.

XToolkitCantWrite - Cannot delete this workspace.

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

Manual References:: Windchill Connectivity APIs: Registering and Activating a Server, Windchill Connectivity APIs: Creating and Modifying the Workspace

Returns:

Activate

void Activate ()

Sets the server to be active in session.

Exceptions thrown (but not limited to):

XToolkitNotFound - The server was not registered.

Manual References:: Windchill Connectivity APIs: Registering and Activating a Server, Windchill Connectivity APIs: Registering and Activating a Server, Windchill Connectivity APIs: To Register a Server with an Existing Workspace

Returns:

CreateWorkspace

void CreateWorkspace (WorkspaceDefinition Definition)

Creates and activates a new workspace.

Exceptions thrown (but not limited to):

XToolkitNotFound - The server is not registered.

XToolkitFound - The workspace already exists.

XToolkitCantWrite - Cannot create a workspace on this server.

Manual References:: Windchill Connectivity APIs: Accessing Workspaces, Windchill Connectivity APIs: Creating and Modifying the Workspace, Windchill Connectivity APIs: Creating and Modifying the Workspace, Windchill Connectivity APIs: To Register a Server with a New Workspace

Parameters:

Definition: Object of WorkspaceDefinitions.

Returns:

UploadObjects

void UploadObjects (Model Mdl)

Uploads an object to the database.

Exceptions thrown (but not limited to):

XToolkitNotFound - The top level object was not found.

XToolkitBadContext - The primary server is not set.

XToolkitCheckoutConflict - Conflicts occurred. Check the details in the conflicts return.

XToolkitNotValid - Upload called for an unsaved object. Please save and then Upload.

See Also:: XToolkitCheckoutConflict

Manual References:: Windchill Connectivity APIs: Upload, Windchill Connectivity APIs: Upload, Windchill Connectivity APIs: Conflicts During Server Operations

Parameters:

Mdl: The model to upload.

Returns:

UploadObjectsWithOptions

void UploadObjectsWithOptions ( /*optional*/ Model TopModel, UploadOptions Options)

Uploads objects to the database with the specified options.

The model should be saved using Model.Save() before it can be uploaded. This function does not save the model by default. The model can also be imported using BaseSession.ImportToCurrentWS(stringseq, RelCriterion) before it can be uploaded.

Exceptions thrown (but not limited to):

XToolkitBadContext - The primary server is not set and/or Design Test Mode is active - the function is not available in this mode.

XToolkitCheckoutConflict - Conflicts occurred. Check the details in the conflicts return.

Manual References:: Windchill Connectivity APIs: Upload, Windchill Connectivity APIs: Upload

Parameters:

TopModel: The model to upload. Pass null to upload the entire workspace
Options: Upload options object of type UploadOptions.

Returns:

CheckinObjects

void CheckinObjects ( /*optional*/ Model Mdl, /*optional*/ CheckinOptions Options)

Checks in an object to the database.

The model must be saved using Model.Save() before it can be checked in. This function does not save the model by default.

Exceptions thrown (but not limited to):

XToolkitBadContext - The primary server is not set and/or Design Test Mode is active - the function is not available in this mode.

XToolkitCheckoutConflict - Conflicts occurred. Check the details in the conflicts return.

See Also:: XToolkitCheckoutConflict

Manual References:: Windchill Connectivity APIs: CheckIn, Windchill Connectivity APIs: CheckIn, Windchill Connectivity APIs: Conflicts During Server Operations

Parameters:

Mdl: The model to checkin. Pass null to check in the entire workspace
Options: Checkin options object of type CheckinOptions. Pass null for a default checkin (as per Creo Parametric's Checkin button in the File menu).

Returns:

CheckoutObjects

String CheckoutObjects ( /*optional*/ Model Mdl, /*optional*/ String File, boolean Checkout, /*optional*/ CheckoutOptions Options)

Checks out or downloads an object to the workspace. Checkout rules are processed based on the Workspace config spec, unless the version is set using CheckoutOptions.GetVersion(/*optional*/ String). If the config spec is LATEST, for example, the latest version of the indicated object(s) will be checked out. If an aliased URL path to the model is supplied, and more than one revision of the model is in the path, Creo Parametric will apply the workspace config spec rules against the objects which reside in that folder.

One of Mdl and File must not be null.This can be either an aliased URL to a given object or the object name.If an aliased URL path to the model is supplied, and more than one revision of the model is in the path, Creo Parametric will apply the workspace config spec rules against the objects which reside in that folder.

Exceptions thrown (but not limited to):

XToolkitNotFound - The top level object was not found.

XToolkitBadContext - The primary server is not set when mdl is passed.

XToolkitCheckoutConflict - Conflicts occurred. Check the details in the conflicts return.

See Also:: XToolkitCheckoutConflict

Manual References:: Windchill Connectivity APIs: Checkout and Download, Windchill Connectivity APIs: Checkout and Download, Windchill Connectivity APIs: Conflicts During Server Operations

Parameters:

Mdl: The top level object to checkout.Can be null
File: The top level object to checkout or download.Can be null.
Checkout: Checkout flag .true to checkout and download, false to download without checking out.
Options: Checkout options object of type CheckoutOptions. Pass null for a default checkout (as per Creo Parametric's Checkout button in the File menu).

Returns:: The url to the top level object in its downloaded/checked out location

CheckoutMultipleObjects

stringseq CheckoutMultipleObjects (stringseq Files, boolean Checkout, /*optional*/ CheckoutOptions Options)

Checks out or downloads multiple objects to the workspace. Checkout rules are processed based on the Workspace config spec, unless the version is set using CheckoutOptions.GetVersion(/*optional*/ String). If the config spec is LATEST, for example, the latest version of the indicated object(s) will be checked out. If an aliased URL path to a model is supplied, and more than one revision of the model is in the path, Creo Parametric will apply the workspace config spec rules against the objects which reside in that folder.

Exceptions thrown (but not limited to):

XToolkitNotFound - The top level object was not found.

XToolkitCheckoutConflict - Conflicts occurred. Check the details in the conflicts return.

Manual References:: Windchill Connectivity APIs: Checkout and Download, Windchill Connectivity APIs: Checkout and Download

Parameters:

Files: Sequence of top level objects to checkout or download. This can contain either aliased URLs to a given object or the object name. If an aliased URL path to the model is supplied, and more than one revision of the model is in the path, Creo Parametric will apply the workspace config spec rules against the objects which reside in that folder.
Checkout: Checkout flag .true to checkout and download, false to download without checking out.
Options: Checkout options object of type CheckoutOptions. Pass null for a default checkout (as per Creo Parametric's Checkout button in the File menu).

Returns:: Sequence of urls to the top level objects in their downloaded/checked out location.

UndoCheckout

void UndoCheckout (Model Mdl)

Undoes the checkout of the given object.

Exceptions thrown (but not limited to):

XToolkitNotFound - The top level object was not found.

XToolkitBadContext - The primary server is not set.

XToolkitCheckoutConflict - Conflicts occurred. Check the details in the conflicts return.

See Also:: XToolkitCheckoutConflict

Manual References:: Windchill Connectivity APIs: Undo Checkout, Windchill Connectivity APIs: Conflicts During Server Operations

Parameters:

Mdl: The top level model that was checked out.

Returns:

RemoveObjects

void RemoveObjects ( /*optional*/ stringseq ModelNames)

Removes a list of models from a workspace.

Exceptions thrown (but not limited to):

XToolkitNotFound - One or more documents are not found. Check the conflicts return.

XToolkitBadContext - The primary server is not set.

XToolkitCheckoutConflict - Conflicts occurred. Check the details in the conflicts output.

See Also:: XToolkitCheckoutConflict

Manual References:: Windchill Connectivity APIs: Delete Objects, Windchill Connectivity APIs: Conflicts During Server Operations

Parameters:

ModelNames

Returns:

IsObjectCheckedOut

boolean IsObjectCheckedOut (String WorkspaceName, String ObjectName)

Returns the checkout status for the given object in the workspace.

Exceptions thrown (but not limited to):

XToolkitNotFound - The given object is not in the workspace.

XToolkitBadContext - The server was not registered or the workspace couldn't be found on the server.

Manual References:: Windchill Connectivity APIs: Server Object Status, Windchill Connectivity APIs: Server Object Status

Parameters:

WorkspaceName: The workspace name.
ObjectName: The object name

Returns:

true if the object is currently checked out to active workspace. false for one of the following cases:

The object is not checked out.
The object is only uploaded to workspace, but was never checked in.
The object is only saved to local workspace cache, but was never uploaded.

IsObjectModified

boolean IsObjectModified (String WorkspaceName, String ObjectName)

Returns the modification status for the given object in the workspace.

Exceptions thrown (but not limited to):

XToolkitNotFound - The given object is not in the workspace.

XToolkitBadContext - The server was not registered or the workspace couldn't be found on the server.

Manual References:: Windchill Connectivity APIs: Server Object Status, Windchill Connectivity APIs: Server Object Status

Parameters:

WorkspaceName: The workspace name.
ObjectName: The object name

Returns:: Object modification status. true if the object was modified locally.

GetAliasedUrl

String GetAliasedUrl (String ModelName)

Gets aliased url for a given model name.

Exceptions thrown (but not limited to):

XToolkitNotFound - The object was not found.

Manual References:: Windchill Connectivity APIs: Utility APIs, Windchill Connectivity APIs: Utility APIs

Parameters:

ModelName: The model name.

Returns:: The aliased url to the model.

IsServerObjectModified

ServerObjectStatus IsServerObjectModified (String WorkspaceName, String ObjectName)

Checks if the given object is modified in workspace or modified locally.

Exceptions thrown (but not limited to):

XToolkitNotFound - The given object is not in the workspace.

XToolkitBadContext - The server was not registered or the workspace couldn't be found on the server.

Manual References:: Windchill Connectivity APIs: Server Object Status, Windchill Connectivity APIs: Server Object Status

Parameters:

WorkspaceName: The workspace name.
ObjectName: The object name.

Returns:: The server object status.