CIP JavaScript documentation for class " pfcServer"

Class pfcServer

Description

This class describes server

Direct Parent Classes:: pfcChild, pfcServerLocation

Property Summary


`string`	`ActiveWorkspace`
	Specifies the name of active server.

`/* readonly */ string`	`Alias`
	Specifies the alias of server.

`/* readonly */ string`	`Context`
	Specifies context of the server

`/* readonly */ boolean`	`IsActive`
	Specifies whether server active or not.

Method Summary


`void`	`Activate ()`
	Sets the server to be active in session.

`void`	`CheckinObjects ( /* optional / pfcModel Mdl, / optional */ pfcCheckinOptions Options)`
	Checks in an object to the database.

`stringseq`	`CheckoutMultipleObjects (stringseq Files, boolean Checkout, /* optional */ pfcCheckoutOptions 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 `pfcCheckoutOptions.Version`. 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 / pfcModel Mdl, / optional / string File, boolean Checkout, / optional */ pfcCheckoutOptions 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 `pfcCheckoutOptions.Version`. 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 (pfcWorkspaceDefinition Definition)`
	Creates and activates a new workspace.

`string`	`GetAliasedUrl (string ModelName)`
	Gets aliased url for a given model name.

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

`pfcServerObjectStatus`	`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`	`UndoCheckout (pfcModel Mdl)`
	Undoes the checkout of the given object.

`void`	`Unregister ()`
	Unregisters a given server and cleans a local cache for the server.

`void`	`UploadObjects (pfcModel Mdl)`
	Uploads an object to the database.

`void`	`UploadObjectsWithOptions ( /* optional */ pfcModel TopModel, pfcUploadOptions Options)`
	Uploads objects to the database with the specified options.

Property Detail

string ActiveWorkspace

Specifies the name of active server.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The server was not registered.

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

pfcXToolkitFound - The workspace is already set.

/* readonly */ string Alias

Specifies the alias of server.

/* readonly */ string Context

Specifies context of the server

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The server was not registered.

/* readonly */ boolean IsActive

Specifies whether server active or not.

Exceptions thrown (but not limited to):

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

Method Detail

void Activate ()

Sets the server to be active in session.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The server was not registered.

void CheckinObjects ( /* optional */ pfcModel Mdl, /* optional */ pfcCheckinOptions Options)

Checks in an object to the database.

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

Exceptions thrown (but not limited to):

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

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

See Also:: pfcXToolkitCheckoutConflict

Parameters:

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

stringseq CheckoutMultipleObjects (stringseq Files, boolean Checkout, /* optional */ pfcCheckoutOptions 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 pfcCheckoutOptions.Version. 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):

pfcXToolkitNotFound - The top level object was not found.

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

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

string CheckoutObjects ( /* optional */ pfcModel Mdl, /* optional */ string File, boolean Checkout, /* optional */ pfcCheckoutOptions 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 pfcCheckoutOptions.Version. 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):

pfcXToolkitNotFound - The top level object was not found.

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

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

See Also:: pfcXToolkitCheckoutConflict

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

void CreateWorkspace (pfcWorkspaceDefinition Definition)

Creates and activates a new workspace.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The server is not registered.

pfcXToolkitFound - The workspace already exists.

pfcXToolkitCantWrite - Cannot create a workspace on this server.

Parameters:

Definition: Object of pfcWorkspaceDefinitions.

string GetAliasedUrl (string ModelName)

Gets aliased url for a given model name.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The object was not found.

Parameters:

ModelName: The model name.

Returns:: The aliased url to the model.

boolean IsObjectCheckedOut (string WorkspaceName, string ObjectName)

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

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The given object is not in the workspace.

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

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.

boolean IsObjectModified (string WorkspaceName, string ObjectName)

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

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The given object is not in the workspace.

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

Parameters:

WorkspaceName: The workspace name.
ObjectName: The object name

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

pfcServerObjectStatus IsServerObjectModified (string WorkspaceName, string ObjectName)

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

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The given object is not in the workspace.

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

Parameters:

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

Returns:: The server object status.

void RemoveObjects ( /* optional */ stringseq ModelNames)

Removes a list of models from a workspace.

Exceptions thrown (but not limited to):

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

pfcXToolkitBadContext - The primary server is not set.

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

See Also:: pfcXToolkitCheckoutConflict

Parameters:

ModelNames

void UndoCheckout (pfcModel Mdl)

Undoes the checkout of the given object.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The top level object was not found.

pfcXToolkitBadContext - The primary server is not set.

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

See Also:: pfcXToolkitCheckoutConflict

Parameters:

Mdl: The top level model that was checked out.

void Unregister ()

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

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The server is not registered.

pfcXToolkitCantWrite - Cannot delete this workspace.

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

void UploadObjects (pfcModel Mdl)

Uploads an object to the database.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The top level object was not found.

pfcXToolkitBadContext - The primary server is not set.

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

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

See Also:: pfcXToolkitCheckoutConflict

Parameters:

Mdl: The model to upload.

void UploadObjectsWithOptions ( /* optional */ pfcModel TopModel, pfcUploadOptions Options)

Uploads objects to the database with the specified options.

The model should be saved using pfcModel.Save() before it can be uploaded. This function does not save the model by default. The model can also be imported using pfcBaseSession.ImportToCurrentWS() before it can be uploaded.

Exceptions thrown (but not limited to):

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

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

Parameters:

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