EKM Client API

- Main Page
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions
com::ansys::ingress::client::api::DataManager Interface Reference

DataManager defines the interface for performing data management operations on an EKM server. These operations include C.R.U.D., version control, locking, and file transfers. More...

List of all members.

## Public Member Functions

ModelObject | AddToVersionControl (ModelObject toAdd, bool recursive=true)
| Adds an object to version control in the EKM server. After adding the object to version control, the object must be checked out before it can be modified.
ModelObject | Checkin (ModelObject obj, string comment="", bool recursive=true)
| Checks an object into version control on the EKM server. The object must first be added to version control, checked out, and modified before checking it back into version control.
ModelObject | Checkout (ModelObject obj, bool recursive=true, bool nonExclusive=false)
| Checks an object out from version control in the EKM server. After the object is checked out, it can only be modified by the user that checked it out. Modifying includes removing the object from version control or deleting it from the repository.
ModelObject | CreateFolder (string parentPath, string name)
| Creates a folder with the given name in the object specified by parentPath.
ModelObject | CreateModelObject (string parentPath, string name, string typename)
| Creates a new object of the given type at the specified path.
bool | DeleteModelObject (string path)
| Deletes an object from the Repository.
void | Download (List< string > source, string destination, bool overwrite, TransferEventListener listener)
| Downloads the objects specified in sources from the EKM server to the destination directory on the client.
void | Download (List< string > source, string destination, bool overwrite, bool @lock, TransferEventListener listener)
| Downloads the objects specified in sources from the EKM server to the destination directory on the client and locks them for exclusive use by the user.
HashSet< ModelObject > | ExecuteSavedQuery (string query, bool shared=false)
| Executes a saved query on the server and returns the results.
void | ExecuteScript (string script)
| Executes the given Python code on the server. For example, ExecuteScript("print 1 + 1") will execute that code on the server.
ModelObject | FindById (string archiveId)
| Searches the EKM Repository for the object with the specified, unique ID.
HashSet< ModelObject > | FindByKeyword (string keyword)
| Searches for objects in the Shared Data and My Data folders that contain the specified keyword in any property.
HashSet< ModelObject > | FindByKeyword (string keyword, List< string > paths)
| Searches for objects in the specified paths that contain the given keyword in any property.
ModelObject | FindByPath (string path)
| Searches the EKM Repository for an object at the specified path.
HashSet< ModelObject > | FindByQuery (Query query)
| Searches the EKM Repository by executing the given query.
CacheStatus | GetCacheStatus (string cacheId)
| Gets the status of a file transfer that is using an EKM cache server.
void | GetChanges (string localCopy, string remoteCopy, TransferEventListener listener)
| Retrieves differences between local copy of files and folders on the user's machine with coresponding files and folders on the EKM server.
List< ModelObject > | GetListing (string path)
| Returns a list of objects for all files and containers in the object at the specified path.
Dictionary< string, ModelSpec > | GetModelSpecs ()
| Retrieves the Model specifications supported by the server.
Dictionary< string, VersionHistoryItem > | GetVersionHistory (ModelObject obj)
| Retrieves the version control history of the specified object from the server.
bool | HasPermission (ModelObject toTest, ICollection< PermissionAction > actions)
| Determines if the current user has permission to perform the specified actions on the given model object.
bool | IsCheckinApplicable (ModelObject obj)
| Returns whether the specified object can be checked into version control. This is based on the version control status of the object as well as whether the object has been modified or not.
bool | IsDataExtractionPending (string path)
| Determines if an object is having metadata extracted from it.
bool | IsUsingCache ()
| Determines if file transfers are using an EKM cache server or not.
bool | Lock (ModelObject toLock, bool recursive=false)
| Locks an object for exclusive use by the current user. The object must be unlocked prior to any other users modifying it.
void | RemoveCacheStatus (String cacheId)
| Removes the status of a transfer that is using an EKM cache server.
ModelObject | RemoveFromVersionControl (ModelObject obj, bool recursive=true)
| Removes an object from version control. The object must first be checked out prior to removing it from version control.
void | RemoveTransferEventListener (TransferEventListener listener)
| Removes a listener previously added to monitor a file transfer.
string | SendChanges (string localCopy, string remoteCopy, TransferEventListener listener, List< string > omissions=null)
| Sends differences between local copy of files and folders on the user's machine with coresponding files and folders on the EKM server.
string | SendChanges (string localCopy, string remoteCopy, TransferEventListener listener, List< string > omissions=null, bool checkin=false, string comment="", bool checkout=false)
| Sends differences between local copy of files and folders on the user's machine with coresponding files and folders on the EKM server.
ModelObject | UndoCheckout (ModelObject obj, bool recursive=true)
| Undo the checkout of the given object.
bool | Unlock (ModelObject toUnlock, bool recursive=false)
| Unlocks an object that was previously locked for exclusive use.
ModelObject | UpdateModelObject (ModelObject modelObject)
| Updates the object on the EKM server.
void | UpdateSubscriptions (string path, int subscription)
| Updates the current user's notifications on the object at the specified path.
void | updateAnalysisProject (string path)
| Updates the Analysis Project object at the specified path.
string | Upload (List< string > source, string destination, TransferEventListener listener, bool overwrite, List< string > omissions=null)
| Uploads the files and folders listed in source to the destination folder on the EKM server.
string | Upload (List< string > source, string destination, TransferEventListener listener, bool overwrite, bool @lock, List< string > omissions=null)
| Uploads the files and folders listed in source to the destination folder on the EKM server and locks them for exclusive use by the user.
string | Upload (List< string > source, string destination, TransferEventListener listener, bool overwrite, bool @lock, int alerts=-1, bool addToVc=false, bool checkin=false, string comment="", bool checkout=false, List< string > omissions=null)
| Uploads the files and folders listed in source to the destination folder on the EKM server and locks them for exclusive use by the user.
string | Upload (List< string > source, string destination, TransferEventListener listener, bool overwrite, bool @lock, int alerts=-1, bool addToVc=false, bool checkin=false, string comment="", bool checkout=false, List< string > omissions=null, string description="")
| Uploads the files and folders listed in source to the destination folder on the EKM server and locks them for exclusive use by the user.

## Detailed Description

DataManager defines the interface for performing data management operations on an EKM server. These operations include C.R.U.D., version control, locking, and file transfers.

## Member Function Documentation

ModelObject com::ansys::ingress::client::api::DataManager::AddToVersionControl | ( | ModelObject | toAdd,
|  | bool | recursive = `true`
| ) |  |

Adds an object to version control in the EKM server. After adding the object to version control, the object must be checked out before it can be modified.

Parameters:

  toAdd | the object to add
  recursive | If all of the object's children should be added to version control. This is true by default

Returns:
  Returns the object that was added to version control.

Exceptions:

  DataException | Thrown if the object could not be added to version control.

ModelObject com::ansys::ingress::client::api::DataManager::Checkin | ( | ModelObject | obj,
|  | string | comment = `""`,
|  | bool | recursive = `true`
| ) |  |

Checks an object into version control on the EKM server. The object must first be added to version control, checked out, and modified before checking it back into version control.

Parameters:

  obj | the object to check into version control
  comment | Description of the modification to the object. This is an empty string by default.
  recursive | If all of the object's children should be checked into version control. This is true by default.

Returns:
  Returns the object that was checked into version control.

Exceptions:

  DataException | Thrown if the object could not be checked into version control.

ModelObject com::ansys::ingress::client::api::DataManager::Checkout | ( | ModelObject | obj,
|  | bool | recursive = `true`,
|  | bool | nonExclusive = `false`
| ) |  |

Checks an object out from version control in the EKM server. After the object is checked out, it can only be modified by the user that checked it out. Modifying includes removing the object from version control or deleting it from the repository.

Parameters:

  obj | the object to check out
  recursive | If all of the object's children should be checked out. This is true by default.

Returns:
  Returns the checked out object.

Exceptions:

  DataException | Thrown if the object could not be checked out from version control.

ModelObject com::ansys::ingress::client::api::DataManager::CreateFolder | ( | string | parentPath,
|  | string | name
| ) |  |

Creates a folder with the given name in the object specified by parentPath.

Parameters:

  parentPath | the path to the parent of the folder being created
  name | the name of the new folder

Returns:
  Returns the new folder.

Exceptions:

  DataException | Thrown if the folder could not be created.

ModelObject com::ansys::ingress::client::api::DataManager::CreateModelObject | ( | string | parentPath,
|  | string | name,
|  | string | typename
| ) |  |

Creates a new object of the given type at the specified path.

Parameters:

  parentPath | the path to the parent of the object being created
  name | the name of the new object
  typename | the type of the object to create

Returns:
  Returns the new object.

Exceptions:

  DataException | Thrown if the object could not be created.

bool com::ansys::ingress::client::api::DataManager::DeleteModelObject | ( | string | path | ) |

Deletes an object from the Repository.

Parameters:

  path | the path of the object to delete.

Returns:
  Returns true if the object was deleted.

void com::ansys::ingress::client::api::DataManager::Download | ( | List< string > | source,
|  | string | destination,
|  | bool | overwrite,
|  | bool @ | lock,
|  | TransferEventListener | listener
| ) |  |

Downloads the objects specified in sources from the EKM server to the destination directory on the client and locks them for exclusive use by the user.

Parameters:

  source | the objects on the server to download
  destination | the directory into which the objects are downloaded
  overwrite | if existing objects in the destination directory are overwritten or not
  lock | if the downloaded objects should be locked for exclusive use by the current user
  listener | the object that receives events related to the download

void com::ansys::ingress::client::api::DataManager::Download | ( | List< string > | source,
|  | string | destination,
|  | bool | overwrite,
|  | TransferEventListener | listener
| ) |  |

Downloads the objects specified in sources from the EKM server to the destination directory on the client.

Parameters:

  source | the objects on the server to download
  destination | the directory into which the objects are downloaded
  overwrite | if existing objects in the destination directory are overwritten or not
  listener | the object that receives events related to the download

HashSet<ModelObject> com::ansys::ingress::client::api::DataManager::ExecuteSavedQuery | ( | string | query,
|  | bool | shared = `false`
| ) |  |

Executes a saved query on the server and returns the results.

Parameters:

  query | the name of the saved query to execute
  shared | If the query is a shared, public query or belongs solely to the user. This is false by default.

Returns:
  Returns the results as a set of ModelObject. The set is guaranteed to not be null, but may be empty if no results are returned by the query or the specified query does not exist.

Exceptions:

  DataException | Thrown if an error occurs executing the search.

void com::ansys::ingress::client::api::DataManager::ExecuteScript | ( | string | script | ) |

Executes the given Python code on the server. For example, ExecuteScript("print 1 + 1") will execute that code on the server.

Parameters:

  script | the code to execute - this is NOT a path to a script on the server

Exceptions:

  DataException | Thrown if an error occurs executing the script.

ModelObject com::ansys::ingress::client::api::DataManager::FindById | ( | string | archiveId | ) |

Searches the EKM Repository for the object with the specified, unique ID.

Parameters:

  archiveId | the ID used to search for the object

Returns:
  Returns the object associated with the ID or null if no object exists with the given ID

HashSet<ModelObject> com::ansys::ingress::client::api::DataManager::FindByKeyword | ( | string | keyword | ) |

Searches for objects in the Shared Data and My Data folders that contain the specified keyword in any property.

Parameters:

  keyword | the keyword to search

Returns:
  Returns a collection of objects that contain the specified keyword in at least one property of the object. The collection will never be null but will be emtpy if no objects contain the keyword.

Exceptions:

  DataException | Thrown if an error occurs executing the search.

HashSet<ModelObject> com::ansys::ingress::client::api::DataManager::FindByKeyword | ( | string | keyword,
|  | List< string > | paths
| ) |  |

Searches for objects in the specified paths that contain the given keyword in any property.

Parameters:

  keyword | the keyword to search
  paths | the paths to search

Returns:
  Returns a collection of objects that contain the specified keyword in at least one property of the object. The collection will never be null but will be emtpy if no objects contain the keyword.

Exceptions:

  DataException | Thrown if an error occurs executing the search.

ModelObject com::ansys::ingress::client::api::DataManager::FindByPath | ( | string | path | ) |

Searches the EKM Repository for an object at the specified path.

Parameters:

  path | the path to search

Returns:
  Returns the object or null if no object exists at the given path.

HashSet<ModelObject> com::ansys::ingress::client::api::DataManager::FindByQuery | ( | Query | query | ) |

Searches the EKM Repository by executing the given query.

Parameters:

  query | the query to execute

Returns:
  Returns the results of the query. The Set is guaranteed to not be null, but it may be empty if the query does not return any results.

CacheStatus com::ansys::ingress::client::api::DataManager::GetCacheStatus | ( | string | cacheId | ) |

Gets the status of a file transfer that is using an EKM cache server.

Parameters:

  cacheId | the ID returned from a download, upload, get changes or send changes call.

Returns:
  Returns the status of the transfer.

void com::ansys::ingress::client::api::DataManager::GetChanges | ( | string | localCopy,
|  | string | remoteCopy,
|  | TransferEventListener | listener
| ) |  |

Retrieves differences between local copy of files and folders on the user's machine with coresponding files and folders on the EKM server.

Parameters:

  localCopy | Specifies the path to the files and folders on the user's machine to check.
  remoteCopy | Specifies the path to the files and folders on the EKM server to check.
  listener | the object that receives events related to downloading the changes from the server

List<ModelObject> com::ansys::ingress::client::api::DataManager::GetListing | ( | string | path | ) |

Returns a list of objects for all files and containers in the object at the specified path.

Parameters:

  path | The path

Returns:
  Returns a list of objects. The list may be empty if the specified object does not contain any files or containers.

Exceptions:

  DataException | Thrown if an error occurs retrieving the list.

Dictionary<string, ModelSpec> com::ansys::ingress::client::api::DataManager::GetModelSpecs | ( |  | ) |

Retrieves the Model specifications supported by the server.

Returns:
  Returns a dictionary where each key is a supporte type and the value is the model specification.

Exceptions:

  DataException | Thrown if an error occurs retrieving the specs.

Dictionary<string, VersionHistoryItem> com::ansys::ingress::client::api::DataManager::GetVersionHistory | ( | ModelObject | obj | ) |

Retrieves the version control history of the specified object from the server.

Parameters:

  obj | the object whose history is retrieved

Returns:
  Returns a dictionay where the keys are the version identifier and the values are the instances of VersionHistoryItem. These items contain the comments for the check in, the user that performed the check in, and the date of the check in.

Exceptions:

  DataException | Thrown if the object's version history could not be retrieved.

bool com::ansys::ingress::client::api::DataManager::HasPermission | ( | ModelObject | toTest,
|  | ICollection< PermissionAction > | actions
| ) |  |

Determines if the current user has permission to perform the specified actions on the given model object.

Parameters:

  toTest | the object to check
  actions | the requested actions

Returns:
  Returns true if the user has all permissions specified in actionsor false if any one of the permissions is denied.

bool com::ansys::ingress::client::api::DataManager::IsCheckinApplicable | ( | ModelObject | obj | ) |

Returns whether the specified object can be checked into version control. This is based on the version control status of the object as well as whether the object has been modified or not.

Parameters:

  obj | the object to check

Returns:
  Returns true if the object can be checked in to version control.

bool com::ansys::ingress::client::api::DataManager::IsDataExtractionPending | ( | string | path | ) |

Determines if an object is having metadata extracted from it.

Parameters:

  path | the path of the object to test

Returns:
  Returns true if the object is having metadata extracted.

bool com::ansys::ingress::client::api::DataManager::IsUsingCache | ( |  | ) |

Determines if file transfers are using an EKM cache server or not.

Returns:
  Returns true if file transfers are using an EKM cache server.

bool com::ansys::ingress::client::api::DataManager::Lock | ( | ModelObject | toLock,
|  | bool | recursive = `false`
| ) |  |

Locks an object for exclusive use by the current user. The object must be unlocked prior to any other users modifying it.

Parameters:

  toLock | the object to lock
  recursive | If all of the object's children should be locked. This is false by default.

Returns:
  Returns true if the object was locked.

void com::ansys::ingress::client::api::DataManager::RemoveCacheStatus | ( | String | cacheId | ) |

Removes the status of a transfer that is using an EKM cache server.

Parameters:

  cacheId | the ID returned from a download, upload, get changes or send changes call.

ModelObject com::ansys::ingress::client::api::DataManager::RemoveFromVersionControl | ( | ModelObject | obj,
|  | bool | recursive = `true`
| ) |  |

Removes an object from version control. The object must first be checked out prior to removing it from version control.

Parameters:

  obj | the object to remove from version control
  recursive | If all of the object's children should be removed from version control. This is true by default.

Exceptions:

  DataException | Thrown if the object could not be removed from version control.

Returns:
  Returns the object that was removed from version control.

void com::ansys::ingress::client::api::DataManager::RemoveTransferEventListener | ( | TransferEventListener | listener | ) |

Removes a listener previously added to monitor a file transfer.

Parameters:

  listener | the listener

string com::ansys::ingress::client::api::DataManager::SendChanges | ( | string | localCopy,
|  | string | remoteCopy,
|  | TransferEventListener | listener,
|  | List< string > | omissions = `null`,
|  | bool | checkin = `false`,
|  | string | comment = `""`,
|  | bool | checkout = `false`
| ) |  |

Sends differences between local copy of files and folders on the user's machine with coresponding files and folders on the EKM server.

Parameters:

  localCopy | Specifies the path to the files and folders on the user's machine to check.
  remoteCopy | Specifies the path to the files and folders on the EKM server to check.
  listener | the object that receives events related to uploading the changes to the server
  omissions | optional list of paths to files or folders that should be omitted from the transfer.
  checkin | Indicates the sent changes should be committed to version control. The default value is false.
  comment | Specifies a comment describing the reason the changes are being committed to version control. The default value is an empty string.
  checkout | Indicates the sent changes should be checked out from version control. The default value is false.

Returns:
  Returns the ID from the cache server if using one. Otherwise, returns null.

string com::ansys::ingress::client::api::DataManager::SendChanges | ( | string | localCopy,
|  | string | remoteCopy,
|  | TransferEventListener | listener,
|  | List< string > | omissions = `null`
| ) |  |

Sends differences between local copy of files and folders on the user's machine with coresponding files and folders on the EKM server.

Parameters:

  localCopy | Specifies the path to the files and folders on the user's machine to check.
  remoteCopy | Specifies the path to the files and folders on the EKM server to check.
  listener | the object that receives events related to uploading the changes to the server
  omissions | optional list of paths to files or folders that should be omitted from the transfer.

Returns:
  Returns the ID from the cache server if using one. Otherwise, returns null.

ModelObject com::ansys::ingress::client::api::DataManager::UndoCheckout | ( | ModelObject | obj,
|  | bool | recursive = `true`
| ) |  |

Undo the checkout of the given object.

Parameters:

  obj | the object to undo
  recursive | If the undo should be applied to all of the object's children. This is true by default.

Exceptions:

  DataException | Thrown if the checkout could not be undone.

Returns:
  Returns the restored object

bool com::ansys::ingress::client::api::DataManager::Unlock | ( | ModelObject | toUnlock,
|  | bool | recursive = `false`
| ) |  |

Unlocks an object that was previously locked for exclusive use.

Parameters:

  toUnlock | the object to unlock
  recursive | If all of the object's children should be unlocked. This is false by default.

Returns:
  Returns true if the object was unlocked.

void com::ansys::ingress::client::api::DataManager::updateAnalysisProject | ( | string | path | ) |

Updates the Analysis Project object at the specified path.

Parameters:

  path | the path to the object to update

notified about

ModelObject com::ansys::ingress::client::api::DataManager::UpdateModelObject | ( | ModelObject | modelObject | ) |

Updates the object on the EKM server.

Parameters:

  modelObject | the object being udpated

Returns:
  Returns the udpated object.

Exceptions:

  DataException | Thrown if the object could not be updated.

void com::ansys::ingress::client::api::DataManager::UpdateSubscriptions | ( | string | path,
|  | int | subscription
| ) |  |

Updates the current user's notifications on the object at the specified path.

Parameters:

  path | the path to the object to update
  subscription | a bitmap of events that the user wishes to be notified about

string com::ansys::ingress::client::api::DataManager::Upload | ( | List< string > | source,
|  | string | destination,
|  | TransferEventListener | listener,
|  | bool | overwrite,
|  | bool @ | lock,
|  | int | alerts = `-1`,
|  | bool | addToVc = `false`,
|  | bool | checkin = `false`,
|  | string | comment = `""`,
|  | bool | checkout = `false`,
|  | List< string > | omissions = `null`
| ) |  |

Uploads the files and folders listed in source to the destination folder on the EKM server and locks them for exclusive use by the user.

Parameters:

  source | the files and folders to upload
  destination | the destination on the server
  listener | the object that receives events related to the upload
  overwrite | if existing objects on the server should be overwritten or not
  lock | if the objects being uploaded should be locked for exclusive use by the current user or not
  alerts | EKM alerts that should be set for the uploaded files and folders. The default is none.
  addToVc | If the uploaded files and folders should be added to version control or not. The default is false.
  checkin | If the uploaded files and folders should be checked into version control. The default is false.
  comment | Comments about the checkin. The default is an empty string.
  checkout | If the uploaded files and folders should be checked out from version control. The default is false.
  omissions | optional list of paths to files or folders that should be omitted from the transfer.

Returns:
  Returns the ID from the cache server if using one. Otherwise, returns null.

string com::ansys::ingress::client::api::DataManager::Upload | ( | List< string > | source,
|  | string | destination,
|  | TransferEventListener | listener,
|  | bool | overwrite,
|  | bool @ | lock,
|  | int | alerts = `-1`,
|  | bool | addToVc = `false`,
|  | bool | checkin = `false`,
|  | string | comment = `""`,
|  | bool | checkout = `false`,
|  | List< string > | omissions = `null`,
|  | string | description = `""`
| ) |  |

Uploads the files and folders listed in source to the destination folder on the EKM server and locks them for exclusive use by the user.

Parameters:

  source | the files and folders to upload
  destination | the destination on the server
  listener | the object that receives events related to the upload
  overwrite | if existing objects on the server should be overwritten or not
  lock | if the objects being uploaded should be locked for exclusive use by the current user or not
  alerts | EKM alerts that should be set for the uploaded files and folders. The default is none.
  addToVc | If the uploaded files and folders should be added to version control or not. The default is false.
  checkin | If the uploaded files and folders should be checked into version control. The default is false.
  comment | Comments about the checkin. The default is an empty string.
  checkout | If the uploaded files and folders should be checked out from version control. The default is false.
  omissions | optional list of paths to files or folders that should be omitted from the transfer.
  description | optional description to be applied to uploaded files.

Returns:
  Returns the ID from the cache server if using one. Otherwise, returns null.

string com::ansys::ingress::client::api::DataManager::Upload | ( | List< string > | source,
|  | string | destination,
|  | TransferEventListener | listener,
|  | bool | overwrite,
|  | bool @ | lock,
|  | List< string > | omissions = `null`
| ) |  |

Uploads the files and folders listed in source to the destination folder on the EKM server and locks them for exclusive use by the user.

Parameters:

  source | the files and folders to upload
  destination | the destination on the server
  listener | the object that receives events related to the upload
  overwrite | if existing objects on the server should be overwritten or not
  lock | if the objects being uploaded should be locked for exclusive use by the current user or not
  omissions | optional list of paths to files or folders that should be omitted from the transfer.

Returns:
  Returns the ID from the cache server if using one. Otherwise, returns null.

string com::ansys::ingress::client::api::DataManager::Upload | ( | List< string > | source,
|  | string | destination,
|  | TransferEventListener | listener,
|  | bool | overwrite,
|  | List< string > | omissions = `null`
| ) |  |

Uploads the files and folders listed in source to the destination folder on the EKM server.

Parameters:

  source | the files and folders to upload
  destination | the destination on the server
  listener | the object that receives events related to the upload
  overwrite | if existing objects on the server should be overwritten or not
  omissions | optional list of paths to files or folders that should be omitted from the transfer.

Returns:
  Returns the ID from the cache server if using one. Otherwise, returns null.

The documentation for this interface was generated from the following file:

- DataManager.cs

All Classes Namespaces Functions Variables Enumerations Properties