Class pfcServer
# include <pfcServer.h>
class pfcServer
: public virtual pfcChild,
: public virtual pfcServerLocation
{
xaideclare(pfcServer)
...
};
Description
This class describes server
User Guide References:
Accessing Information Before Registering a Server:pfcServer, Registering and Activating a Server:pfcServer, Accessing Information From a Registered Server:pfcServer, Accessing Workspaces:pfcServer, Creating and Modifying the Workspace:pfcServer, Workflow to Register a Server:pfcServer, To Register a Server with a New Workspace:pfcServer, Upload:pfcServer, CheckIn:pfcServer, Checkout and Download:pfcServer, Undo Checkout:pfcServer, Server Object Status:pfcServer, Delete Objects:pfcServer, Conflicts During Server Operations:pfcServer, Utility APIs:pfcServer
Methods Inherited from Class pfcChild::
Methods Inherited from Class pfcServerLocation::
Method Summary
void | Activate () |
Sets the server to be active in session. | |
void | |
Checks in an object to the database. | |
CheckoutMultipleObjects (xstringsequence_ptr Files, xbool Checkout, cipOptional pfcCheckoutOptions_ptr 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::GetVersion(cipOptional xrstring). 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. | |
CheckoutObjects (cipOptional pfcModel_ptr Mdl, cipOptional xrstring File, xbool Checkout, cipOptional pfcCheckoutOptions_ptr 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::GetVersion(cipOptional xrstring). 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 | |
Creates and activates a new workspace. | |
void | |
Specifies the name of active server. | |
GetAlias () | |
Specifies the alias of server. | |
Gets aliased url for a given model name. | |
GetContext () | |
Specifies context of the server | |
GetIsActive () | |
Specifies whether server active or not. | |
Returns the checkout status for the given object in the workspace. | |
Returns the modification status for the given object in the workspace. | |
Checks if the given object is modified in workspace or modified locally. | |
void | |
Removes a list of models from a workspace. | |
void | |
Undoes the checkout of the given object. | |
void | Unregister () |
Unregisters a given server and cleans a local cache for the server. | |
void | |
Uploads an object to the database. | |
void | |
Uploads objects to the database with the specified options. |
Method Detail
GetAlias | () |
Specifies the alias of server.
User Guide References:
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.
User Guide References:
GetIsActive | () |
Specifies whether server active or not.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - There is no active aliased server (Local Dir is active).
User Guide References:
GetContext | () |
Specifies context of the server
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The server was not registered.
User Guide References:
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.
User Guide References:
Returns:
void | Activate | () |
Sets the server to be active in session.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The server was not registered.
User Guide References:
Returns:
void | CreateWorkspace |
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.
User Guide References:
Parameters:
Definition
Object of pfcWorkspaceDefinitions.
Returns:
void | UploadObjects |
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:
User Guide References:
Parameters:
Mdl
The model to upload.
Returns:
void | UploadObjectsWithOptions |
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(xstringsequence_ptr, pfcRelCriterion) 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.
User Guide References:
Parameters:
TopModel
The model to upload. Pass null to upload the entire workspace
Options
Upload options object of type pfcUploadOptions.
Returns:
void | CheckinObjects |
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:
User Guide References:
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).
Returns:
CheckoutObjects | (cipOptional pfcModel_ptr Mdl, cipOptional xrstring File, xbool Checkout, cipOptional pfcCheckoutOptions_ptr 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::GetVersion(cipOptional xrstring). 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:
User Guide References:
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
CheckoutMultipleObjects |
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::GetVersion(cipOptional xrstring). 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.
User Guide References:
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.
void | UndoCheckout |
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:
User Guide References:
Parameters:
Mdl
The top level model that was checked out.
Returns:
void | RemoveObjects |
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:
User Guide References:
Parameters:
ModelNames
Returns:
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.
User Guide References:
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.
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.
User Guide References:
Parameters:
WorkspaceName
The workspace name.
ObjectName
The object name
Returns:
Object modification status. true if the object was modified locally.
Gets aliased url for a given model name.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The object was not found.
User Guide References:
Parameters:
ModelName
The model name.
Returns:
The aliased url to the model.
IsServerObjectModified |
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.
User Guide References:
Parameters:
WorkspaceName
The workspace name.
ObjectName
The object name.
Returns:
The server object status.