CIP Visual Basic.NET documentation for interface "IpfcServer"

Interface IpfcServer

Description

This class describes server

Direct Parent Classes:: IpfcChild, IpfcServerLocation

Property Summary


`Property`	`ActiveWorkspace`	`as String`
	Specifies the name of active server.

`Property`	`Alias`	`as String`
	Specifies the alias of server.

`Property`	`Context`	`as String`
	Specifies context of the server

`Property`	`IsActive`	`as Boolean`
	Specifies whether server active or not.

Method Summary


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

`Sub`	`CheckinObjects (Mdl as IpfcModel [optional], Options as IpfcCheckinOptions [optional])`
	Checks in an object to the database.

`Function`	`CheckoutMultipleObjects (Files as Istringseq, Checkout as Boolean, Options as IpfcCheckoutOptions [optional]) as Istringseq`
	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 `IpfcCheckoutOptions.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.

`Function`	`CheckoutObjects (Mdl as IpfcModel [optional], File as String [optional], Checkout as Boolean, Options as IpfcCheckoutOptions [optional]) as String`
	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 `IpfcCheckoutOptions.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.

`Sub`	`CreateWorkspace (Definition as IpfcWorkspaceDefinition)`
	Creates and activates a new workspace.

`Function`	`GetAliasedUrl (ModelName as String) as String`
	Gets aliased url for a given model name.

`Function`	`IsObjectCheckedOut (WorkspaceName as String, ObjectName as String) as Boolean`
	Returns the checkout status for the given object in the workspace.

`Function`	`IsObjectModified (WorkspaceName as String, ObjectName as String) as Boolean`
	Returns the modification status for the given object in the workspace.

`Function`	`IsServerObjectModified (WorkspaceName as String, ObjectName as String) as IpfcServerObjectStatus`
	Checks if the given object is modified in workspace or modified locally.

`Sub`	`RemoveObjects (ModelNames as Istringseq [optional])`
	Removes a list of models from a workspace.

`Sub`	`UndoCheckout (Mdl as IpfcModel)`
	Undoes the checkout of the given object.

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

`Sub`	`UploadObjects (Mdl as IpfcModel)`
	Uploads an object to the database.

`Sub`	`UploadObjectsWithOptions (TopModel as IpfcModel [optional], Options as IpfcUploadOptions)`
	Uploads objects to the database with the specified options.

Property Detail

Property ActiveWorkspace as String

Specifies the name of active server.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The server was not registered.

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

IpfcXToolkitFound - The workspace is already set.

Property Alias as String

Specifies the alias of server.

Property Context as String

Specifies context of the server

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The server was not registered.

Property IsActive as Boolean

Specifies whether server active or not.

Exceptions thrown (but not limited to):

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

Method Detail

Sub Activate ()

Sets the server to be active in session.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The server was not registered.

Sub CheckinObjects (Mdl as IpfcModel [optional], Options as IpfcCheckinOptions [optional])

Checks in an object to the database.

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

Exceptions thrown (but not limited to):

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

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

See Also:: IpfcXToolkitCheckoutConflict

Manual References:: Windchill Connectivity APIs: Sample Batch Workflow

Parameters:

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

Function CheckoutMultipleObjects (Files as Istringseq, Checkout as Boolean, Options as IpfcCheckoutOptions [optional]) as Istringseq

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

IpfcXToolkitNotFound - The top level object was not found.

IpfcXToolkitCheckoutConflict - 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 IpfcCheckoutOptions. 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.

Function CheckoutObjects (Mdl as IpfcModel [optional], File as String [optional], Checkout as Boolean, Options as IpfcCheckoutOptions [optional]) as String

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

IpfcXToolkitNotFound - The top level object was not found.

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

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

See Also:: IpfcXToolkitCheckoutConflict

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

Sub CreateWorkspace (Definition as IpfcWorkspaceDefinition)

Creates and activates a new workspace.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The server is not registered.

IpfcXToolkitFound - The workspace already exists.

IpfcXToolkitCantWrite - Cannot create a workspace on this server.

Parameters:

Definition: Object of IpfcWorkspaceDefinitions.

Function GetAliasedUrl (ModelName as String) as String

Gets aliased url for a given model name.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The object was not found.

Parameters:

ModelName: The model name.

Returns:: The aliased url to the model.

Function IsObjectCheckedOut (WorkspaceName as String, ObjectName as String) as Boolean

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

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The given object is not in the workspace.

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

Function IsObjectModified (WorkspaceName as String, ObjectName as String) as Boolean

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

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The given object is not in the workspace.

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

Function IsServerObjectModified (WorkspaceName as String, ObjectName as String) as IpfcServerObjectStatus

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

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The given object is not in the workspace.

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

Sub RemoveObjects (ModelNames as Istringseq [optional])

Removes a list of models from a workspace.

Exceptions thrown (but not limited to):

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

IpfcXToolkitBadContext - The primary server is not set.

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

See Also:: IpfcXToolkitCheckoutConflict

Parameters:

ModelNames

Sub UndoCheckout (Mdl as IpfcModel)

Undoes the checkout of the given object.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The top level object was not found.

IpfcXToolkitBadContext - The primary server is not set.

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

See Also:: IpfcXToolkitCheckoutConflict

Parameters:

Mdl: The top level model that was checked out.

Sub Unregister ()

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

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The server is not registered.

IpfcXToolkitCantWrite - Cannot delete this workspace.

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

Sub UploadObjects (Mdl as IpfcModel)

Uploads an object to the database.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The top level object was not found.

IpfcXToolkitBadContext - The primary server is not set.

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

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

See Also:: IpfcXToolkitCheckoutConflict

Parameters:

Mdl: The model to upload.

Sub UploadObjectsWithOptions (TopModel as IpfcModel [optional], Options as IpfcUploadOptions)

Uploads objects to the database with the specified options.

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

Exceptions thrown (but not limited to):

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

IpfcXToolkitCheckoutConflict - 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 IpfcUploadOptions.