A B C D E F G H I J L M N O P Q R S T U V W

## A

AbortJob(String, String, String) - Method in interface com.ansys.ingress.client.api.JobManager
ACCESS_ACTION - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  ACCESS_ACTION specifies the permission for accessing an object.
ACTIVE - Static variable in class com.ansys.ingress.client.api.CacheStatus
  ACTIVE - the transfer is currently active on the EKM cache server.
addFailedItem(String, Throwable) - Method in class com.ansys.ingress.client.api.transfers.TransferEvent.Error
  Adds a failed item.
AddLogMessages(String, String, int, String) - Method in interface com.ansys.ingress.client.api.JobManager
  Log a message(s) to RSM job report for the specified job
addPackage(String) - Method in class com.ansys.ingress.client.api.utils.Localizer
  Adds a package to the localizer.
addProxy(String) - Method in class com.ansys.ingress.client.api.utils.HttpProxySelector
  Adds a proxy to the selector.
addProxy(URL) - Method in class com.ansys.ingress.client.api.utils.HttpProxySelector
  Adds a proxy to the selector.
addRow(QueryRow) - Method in class com.ansys.ingress.client.api.search.QueryOperation
  Adds a row to this operation.
addSubExpression(QueryOperation) - Method in class com.ansys.ingress.client.api.search.QueryOperation
  Adds a subexpression to this operation.
addSubgroups(List<String>, String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Adds subgroups to the specified group.
addToVersionControl(ModelObject) - Method in interface com.ansys.ingress.client.api.DataManager
  Adds an object and all of its children to version control in the EKM server.
addToVersionControl(ModelObject, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Adds an object to version control in the EKM server.
addUsersToGroup(List<String>, String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Adds the users in the list to the specified group.
AdministrationException - Exception in com.ansys.ingress.client.api
  AdministrationException is the exception thrown when operations defined in the `AdministrationManager` interface fail.
AdministrationException(Exception) - Constructor for exception com.ansys.ingress.client.api.AdministrationException
  Creates a new instance of AdministrationException.
AdministrationException(AdministrationException.Reason, Exception, Object...) - Constructor for exception com.ansys.ingress.client.api.AdministrationException
  Creates a new instance of AdministrationException.
AdministrationException.Reason - Enum in com.ansys.ingress.client.api
  Reason defines the message keys for an `AdministrationException`.
AdministrationManager - Interface in com.ansys.ingress.client.api
  AdministrationManager provides the interface to perform administrative operations on an EKM server.
ALL - Static variable in interface com.ansys.ingress.client.api.Subscriptions
  Event reason constant.
allowsChildBasedSearch() - Method in class com.ansys.ingress.client.api.search.QueryOperation
allowsSubExpressionSearch() - Method in class com.ansys.ingress.client.api.search.QueryOperation
ANSYS_VERSION - Static variable in class com.ansys.ingress.client.api.utils.Platform
ATTRIBUTE_VERSIONED_OBJECT_IDENTIFIER - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  ATTRIBUTE_VERSIONED_OBJECT_IDENTIFIER is the property that contains the ID of an object under version control.

## B

belongsTo(String, String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Determines if the member (a user or group) belongs to the specified group.

## C

CACHE_USER_TYPE - Static variable in class com.ansys.ingress.client.api.Credentials
  CACHE_USER_TYPE needs to be kept in sync with core AuthenticationToken.CACHE_USER_TYPE.
cacheid - Variable in class com.ansys.ingress.client.api.schema.ConnectorEvent
CacheStatus - Class in com.ansys.ingress.client.api
  CacheStatus provides status information about transfers that are using the EKM cache server.
CacheStatus() - Constructor for class com.ansys.ingress.client.api.CacheStatus
CancelCall(String) - Method in interface com.ansys.ingress.client.api.JobManager
  Attempts to cancel an operation that is in progress
cause - Variable in class com.ansys.ingress.client.api.schema.ConnectorEventError
CheckClientDirectoryVisibility(String, String, String, List<String>) - Method in interface com.ansys.ingress.client.api.JobManager
  Check if client directory is visible
CHECKED_OUT_BY_PROPERTY - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  CHECKED_OUT_BY_PROPERTY is the property that contains the name of the user that has an object checked out from version control.
checkin(ModelObject, String) - Method in interface com.ansys.ingress.client.api.DataManager
  Checks an object and all of its children into version control on the EKM server.
checkin(ModelObject, String, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Checks an object into version control on the EKM server.
CHECKIN_AFTER_EXTRACT - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  CHECKIN_AFTER_EXTRACT is the name of a property used to indicate that an uploaded file should be checked into version control once it has had metadata extracted on the server.
CHECKIN_AFTER_EXTRACT_COMMENT - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  CHECKIN_AFTER_EXTRACT_COMMENT is the name of a property containing a comment describing the changes made to an object when it is checked into version control.
CHECKIN_CHECKOUT - Static variable in interface com.ansys.ingress.client.api.Subscriptions
  Event reason constant.
CHECKIN_DISABLED_OPTION - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  CHECKIN_DISABLED_OPTION indicates an object is not under version control
CHECKIN_ENABLED_OPTION - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  CHECKIN_ENABLED_OPTION indicates an object is under version control
CHECKIN_POLICY_PROPERTY - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  CHECKIN_POLICY_PROPERTY is the property that specifies the checkin policy of an object in the repository.
checkout(ModelObject) - Method in interface com.ansys.ingress.client.api.DataManager
  Checks an object and all of its children out from version control in the EKM server.
checkout(ModelObject, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Checks an object out from version control in the EKM server.
checkout(ModelObject, boolean, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Checks an object out from version control in the EKM server.
CHECKOUT_ACTION - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  CHECKOUT_ACTION specifies the permission for checking an object out of version control.
CHECKOUT_AFTER_EXTRACT - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  CHECKOUT_AFTER_EXTRACT indicates an object should be checked out from version control once data extraction is complete.
CHILD_ADDED - Static variable in interface com.ansys.ingress.client.api.Subscriptions
  Event reason constant.
CHILD_REMOVED - Static variable in interface com.ansys.ingress.client.api.Subscriptions
  Event reason constant.
clearRecycleBin() - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Clears the current user's recycle bin on the EKM server.
clearSpecCache() - Method in interface com.ansys.ingress.client.api.DataManager
  Clears the cache of object types maintained in the client.
cloneForPersistence() - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Creates a clone of this object that is safe to persist.
close() - Method in interface com.ansys.ingress.client.api.Connection
  Closes this connection.
close(boolean) - Method in interface com.ansys.ingress.client.api.Connection
  Closes this connection.
close(boolean, boolean) - Method in interface com.ansys.ingress.client.api.Connection
  Closes this connection.
close(String, boolean) - Method in interface com.ansys.ingress.client.api.Connection
  Closes the connection and saves it using the given name.
com.ansys.ingress.client.api - package com.ansys.ingress.client.api
  This package contains the interfaces used to communicate and interact with an EKM server.
com.ansys.ingress.client.api.schema - package com.ansys.ingress.client.api.schema
  This package contains data structures generated from schema and used by the EKM Client API.
com.ansys.ingress.client.api.search - package com.ansys.ingress.client.api.search
  This package contains classes for creating queries that can be executed on the EKM server and for processing the results of the executed queries.
com.ansys.ingress.client.api.transfers - package com.ansys.ingress.client.api.transfers
  This package contains the classes and interfaces used to monitor file transfers between the client and the EKM server.
com.ansys.ingress.client.api.utils - package com.ansys.ingress.client.api.utils
  This package containus utility classes.
compare(RepositorySearchResult, RepositorySearchResult) - Method in class com.ansys.ingress.client.api.search.RepositorySearchResultComparator
CompleteCall(String) - Method in interface com.ansys.ingress.client.api.JobManager
  Signals that a call is complete.
COMPLETED - Static variable in class com.ansys.ingress.client.api.CacheStatus
  COMPLETED - the EKM cache server has completed the transfer.
Condition - Enum in com.ansys.ingress.client.api.search
  Condition used in a row in a query to determine how to compare values.
connect(String, String, String, String) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Connects to an EKM server using the user's archive ID and an authentication token from a previously established session.
connectFailed(URI, SocketAddress, IOException) - Method in class com.ansys.ingress.client.api.utils.HttpProxySelector
Connection - Interface in com.ansys.ingress.client.api
  Connection represents a connection to an EKM server.
ConnectionDetails - Class in com.ansys.ingress.client.api
  ConnectionDetails provides information about a connection to an EKM server.
ConnectionDetails(String, URI, String, String, String, boolean) - Constructor for class com.ansys.ingress.client.api.ConnectionDetails
  Creates a new instance of ConnectionDetails.
ConnectionDetails(String, URL, String, Credentials, boolean) - Constructor for class com.ansys.ingress.client.api.ConnectionDetails
  Creates a new instance of ConnectionDetails.
ConnectionDetails() - Constructor for class com.ansys.ingress.client.api.ConnectionDetails
  Creates a new instance of ConnectionDetails.
ConnectionException - Exception in com.ansys.ingress.client.api
  ConnectionException is the exception thrown due to problems communicating with an EKM server.
ConnectionException(ConnectionException.Reason) - Constructor for exception com.ansys.ingress.client.api.ConnectionException
  Creates a new instance of ConnectionException.
ConnectionException(ConnectionException.Reason, Exception, Object...) - Constructor for exception com.ansys.ingress.client.api.ConnectionException
  Creates a new instance of ConnectionException.
ConnectionException(ConnectionException.Reason, Object...) - Constructor for exception com.ansys.ingress.client.api.ConnectionException
  Creates a new instance of ConnectionException.
ConnectionException.Reason - Enum in com.ansys.ingress.client.api
  Reason defines the reasons for a `ConnectionException`.
ConnectionFactory - Class in com.ansys.ingress.client.api
  ConnectionFactory is used to open connections to an EKM server.
ConnectionFactory() - Constructor for class com.ansys.ingress.client.api.ConnectionFactory
ConnectionFactory.TokenUserType - Enum in com.ansys.ingress.client.api
  TokenUserType defines the user types that can login to EKM using a special token.
ConnectorEvent - Class in com.ansys.ingress.client.api.schema
  Java class for ConnectorEvent complex type.
ConnectorEvent() - Constructor for class com.ansys.ingress.client.api.schema.ConnectorEvent
ConnectorEventError - Class in com.ansys.ingress.client.api.schema
  Java class for ConnectorEventError complex type.
ConnectorEventError() - Constructor for class com.ansys.ingress.client.api.schema.ConnectorEventError
ConnectorEventReason - Enum in com.ansys.ingress.client.api.schema
  Java class for ConnectorEventReason.
ConnectorExceptionData - Class in com.ansys.ingress.client.api.schema
  Java class for ConnectorExceptionData complex type.
ConnectorExceptionData() - Constructor for class com.ansys.ingress.client.api.schema.ConnectorExceptionData
ConnectorRequest - Class in com.ansys.ingress.client.api.schema
  Java class for ConnectorRequest complex type.
ConnectorRequest() - Constructor for class com.ansys.ingress.client.api.schema.ConnectorRequest
ConnectorResponse - Class in com.ansys.ingress.client.api.schema
  Java class for ConnectorResponse complex type.
ConnectorResponse() - Constructor for class com.ansys.ingress.client.api.schema.ConnectorResponse
CONTENT_MODIFICATION_TIME_PROPERTY - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  CONTENT_MODIFICATION_TIME_PROPERTY is the property containing the date and time a file's content was last modified
CONTENT_TYPE_PROPERTY - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  CONTENT_TYPE_PROPERTY is the property containing an object's content type.
controller - Variable in class com.ansys.ingress.client.api.schema.ConnectorRequest
CREATE_ACTION - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  CREATE_ACTION specifies the permission for creating an object in the repository.
createConnectorEvent() - Method in class com.ansys.ingress.client.api.schema.ObjectFactory
  Create an instance of `ConnectorEvent`
createConnectorEventError() - Method in class com.ansys.ingress.client.api.schema.ObjectFactory
  Create an instance of `ConnectorEventError`
createConnectorExceptionData() - Method in class com.ansys.ingress.client.api.schema.ObjectFactory
  Create an instance of `ConnectorExceptionData`
createConnectorRequest() - Method in class com.ansys.ingress.client.api.schema.ObjectFactory
  Create an instance of `ConnectorRequest`
createConnectorResponse() - Method in class com.ansys.ingress.client.api.schema.ObjectFactory
  Create an instance of `ConnectorResponse`
createError(JobEvent, TransferEvent) - Method in class com.ansys.ingress.client.api.transfers.TransferMonitor
  Creates a `TransferEvent.Error`.
createError(TransferEvent.Error) - Method in class com.ansys.ingress.client.api.transfers.TransferMonitor
  Creates a `ConnectorEventError` from error information in a `TransferEvent.Error`.
createEvent(ConnectorEvent) - Method in class com.ansys.ingress.client.api.schema.ObjectFactory
  Create an instance of `JAXBElement``<``ConnectorEvent``>`}
createFolder(String, String) - Method in interface com.ansys.ingress.client.api.DataManager
  Creates a folder with the given name in the object specified by parentPath.
createGroup(String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Creates a new group.
CreateJob(String, String) - Method in interface com.ansys.ingress.client.api.JobManager
  Creates a job in RSM
CreateJobSpace(String, String, String, List<String>) - Method in interface com.ansys.ingress.client.api.JobManager
  Create a JobObject in EKM and launch servo for current user.
createModelObject(String, String, String) - Method in interface com.ansys.ingress.client.api.DataManager
  Creates a new object of the given type at the specified path.
createQueryRow(String, Condition, boolean) - Method in class com.ansys.ingress.client.api.search.Query
  Creates a query row for a query.
createQueryRow(String, Condition, Calendar) - Method in class com.ansys.ingress.client.api.search.Query
  Creates a query row for a query.
createQueryRow(String, Condition, double) - Method in class com.ansys.ingress.client.api.search.Query
  Creates a query row for a query.
createQueryRow(String, Condition, long) - Method in class com.ansys.ingress.client.api.search.Query
  Creates a query row for a query.
createQueryRow(String, Condition, String) - Method in class com.ansys.ingress.client.api.search.Query
  Creates a query row for a query.
createQueryRow(String, Condition, List<String>) - Method in class com.ansys.ingress.client.api.search.Query
  Creates a query row for a query.
createRequest(ConnectorRequest) - Method in class com.ansys.ingress.client.api.schema.ObjectFactory
  Create an instance of `JAXBElement``<``ConnectorRequest``>`}
createResponse(ConnectorResponse) - Method in class com.ansys.ingress.client.api.schema.ObjectFactory
  Create an instance of `JAXBElement``<``ConnectorResponse``>`}
createUser(String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Creates a new user account on the EKM server.
createUser(String, String, String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Creates a new user account on the EKM server and sets the job execution username and password.
CREATION_TIME_PROPERTY - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  CREATION_TIME_PROPERTY is the property the specifies the time an object was created.
CREATOR_PROPERTY - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  CREATOR_PROPERTY is the property that specifies the user that created an object.
Credentials - Class in com.ansys.ingress.client.api
  Credentials define the tokens used to authenticate with an EKM repository.
Credentials() - Constructor for class com.ansys.ingress.client.api.Credentials
  Creates a new instance of Credentials.
Credentials(String, char[], String) - Constructor for class com.ansys.ingress.client.api.Credentials
  Creates a new instance of Credentials.
Credentials(String, char[], String, boolean) - Constructor for class com.ansys.ingress.client.api.Credentials
  Creates a new instance of Credentials.
Credentials(int, String, String) - Constructor for class com.ansys.ingress.client.api.Credentials
  Creates a new instance of Credentials.
credentialsMatch(String, String) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Determines if the given username and password match the ones associated with this connection.
credentialsMatch(String, String, String) - Method in class com.ansys.ingress.client.api.Credentials
  Determines if the given credentials match these credentials.

## D

DataException - Exception in com.ansys.ingress.client.api
  DataException is the exception thrown by operations defined in the `DataManager` interface.
DataException(Exception) - Constructor for exception com.ansys.ingress.client.api.DataException
  Creates a new instance of DataException.
DataException(DataException.Reason) - Constructor for exception com.ansys.ingress.client.api.DataException
  Creates a new instance of DataException.
DataException(DataException.Reason, Exception, Object...) - Constructor for exception com.ansys.ingress.client.api.DataException
  Creates a new instance of DataException.
DataException.Reason - Enum in com.ansys.ingress.client.api
  Reason defines the message keys for a `DataException`.
dataExtractionCompleted(TransferEvent) - Method in class com.ansys.ingress.client.api.transfers.TransferEventAdapter
dataExtractionCompleted(TransferEvent) - Method in interface com.ansys.ingress.client.api.transfers.TransferEventListener
  Indicates metadata extraction completed on the server.
dataExtractionStarted(TransferEvent) - Method in class com.ansys.ingress.client.api.transfers.TransferEventAdapter
dataExtractionStarted(TransferEvent) - Method in interface com.ansys.ingress.client.api.transfers.TransferEventListener
  Indicates metadata extraction started on the server.
DataManager - Interface in com.ansys.ingress.client.api
  DataManager defines the interface for performing data management operations on an EKM server.
DEFAULT_TYPENAME - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  DEFAULT_TYPENAME is the default type name for objects on the server.
delete() - Method in interface com.ansys.ingress.client.api.Connection
  Deletes this connection.
DELETE_ACTION - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  DELETE_ACTION specifies the permission for deleting an object in the repository.
deleteConnection(String) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Deletes the connection with the given name.
deleteMember(String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Deletes a user or group.
deleteModelObject(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Deletes the object at the specified path.
DESCRIPTION_PROPERTY - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  Name of the description property.
deserializeModelObject(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Deserializes an XML string into a ModelObject instance.
download(List<String>, String, TransferEventListener) - Method in interface com.ansys.ingress.client.api.DataManager
  Downloads the objects specified in sources from the EKM server to the destination directory on the client.
download(List<String>, String, boolean, TransferEventListener) - Method in interface com.ansys.ingress.client.api.DataManager
  Downloads the objects specified in sources from the EKM server to the destination directory on the client.
download(List<String>, String, boolean, boolean, TransferEventListener) - Method in interface com.ansys.ingress.client.api.DataManager
  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.
DOWNLOAD - Static variable in interface com.ansys.ingress.client.api.Subscriptions
  Event reason constant.
DOWNLOAD_ACTION - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  DOWNLOAD_ACTION is the action name for downloading a file from the server.
DownloadFile(String, String, String, String) - Method in interface com.ansys.ingress.client.api.JobManager
  Download a file from workingDirectory/sourceRelativeFilePath of the the JobObject with id=jobSpaceId and write to destinationLocalFilePath

## E

EKM_CONNECTION_FACTORY_PROVIDER - Static variable in class com.ansys.ingress.client.api.ConnectionFactory
  EKM_CONNECTION_FACTORY_PROVIDER is an evnironment variable that can be set to change the default connection factory provider.
EkmException - Exception in com.ansys.ingress.client.api
  EkmException is the generic exception thrown by methods defined in the EKM Client API.
EkmException(String) - Constructor for exception com.ansys.ingress.client.api.EkmException
  Creates a new instance of EkmException.
EkmException(Throwable) - Constructor for exception com.ansys.ingress.client.api.EkmException
  Creates a new instance of EkmException.
EkmException(String, Exception, Object...) - Constructor for exception com.ansys.ingress.client.api.EkmException
  Creates a new instance of EkmException.
EkmException(String, Object...) - Constructor for exception com.ansys.ingress.client.api.EkmException
  Creates a new instance of EkmException.
EkmException(EkmException.Reason, Object...) - Constructor for exception com.ansys.ingress.client.api.EkmException
  Creates a new instance of EkmException.
EkmException(EkmException.Reason, Exception, Object...) - Constructor for exception com.ansys.ingress.client.api.EkmException
  Creates a new instance of EkmException.
EkmException.Reason - Enum in com.ansys.ingress.client.api
  Reason defines the reasons for an `EkmException`.
equals(Object) - Method in class com.ansys.ingress.client.api.Credentials
error - Variable in class com.ansys.ingress.client.api.schema.ConnectorEvent
Error() - Constructor for class com.ansys.ingress.client.api.transfers.TransferEvent.Error
exception - Variable in class com.ansys.ingress.client.api.schema.ConnectorEventError
exception - Variable in class com.ansys.ingress.client.api.schema.ConnectorResponse
exceptionClass - Variable in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
exceptionMessage - Variable in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
executeSavedQuery(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Executes a user's saved query on the server and returns the results.
executeSavedQuery(String, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Executes a saved query on the server and returns the results.
executeScript(String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  For a user with appropriate privileges, executes the given Python code on the server.
executeScript(String, String, String, String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  For a user with appropriate privileges, executes the given script code on the server and returns the results.
executeSearch() - Method in class com.ansys.ingress.client.api.search.RepositorySearch
executeSearch(boolean) - Method in class com.ansys.ingress.client.api.search.RepositorySearch

## F

FAILED - Static variable in class com.ansys.ingress.client.api.CacheStatus
  FAILED - the EKM cache server encountered an error in the transfer.
FailedItem() - Constructor for class com.ansys.ingress.client.api.transfers.TransferEvent.FailedItem
failures - Variable in class com.ansys.ingress.client.api.schema.ConnectorEventError
FILE_TYPE - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  Default type name for EKM file.
fileDownloaded(TransferEvent) - Method in class com.ansys.ingress.client.api.transfers.TransferEventAdapter
fileDownloaded(TransferEvent) - Method in interface com.ansys.ingress.client.api.transfers.TransferEventListener
  For a download, indicates a file has been downloaded to the destination file system.
FinalizeJob(String, String, String, String) - Method in interface com.ansys.ingress.client.api.JobManager
findAppPathLinux(String) - Static method in class com.ansys.ingress.client.api.utils.Platform
  Finds the path to an application on Linux using which.
findById(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Searches the EKM Repository for the object with the specified, unique ID.
findByKeyword(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Searches for objects, in the Shared Data and user's My Data folders, that contain the specified keyword in any property.
findByKeyword(String, List<String>) - Method in interface com.ansys.ingress.client.api.DataManager
  Searches for objects, in the specified paths, that contain the specified keyword in any property.
findByPath(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Searches the EKM Repository for an object at the specified path.
findByQuery(Query) - Method in interface com.ansys.ingress.client.api.DataManager
  Searches the EKM Repository by executing the given query.
findByQuery(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Searches the EKM server for objects using the given XML query.
findByQuery(String) - Method in class com.ansys.ingress.client.api.search.RepositorySearch
  Sends the query to the EKM server and returns the results.
findByQueryExpression(String) - Method in class com.ansys.ingress.client.api.search.RepositorySearch
  Sends the query expression to the EKM server and returns the results.
findConnection(String, String) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Finds a connection based on a URL and workspace.
findConnection(String, String, String) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Finds a conneciton with a matching location, username, and password.
findGroup(String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Searches the groups defined in EKM for the one with the given name.
findUser(String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Searches the user accounts defined in EKM for the user with the specified name.
fixUpPath(String, String) - Static method in class com.ansys.ingress.client.api.utils.PathUtils
  Fixes up paths that start in the user's "My Data" folder.
FOLDER_TYPE - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  Default type name for EKM folders.
fromString(String) - Static method in enum com.ansys.ingress.client.api.ConnectionFactory.TokenUserType
  Gets a TokenUserType value based on the given string.
fromString(String) - Static method in enum com.ansys.ingress.client.api.PermissionAction
  Creates a permission action from a string.
fromValue(String) - Static method in enum com.ansys.ingress.client.api.schema.ConnectorEventReason
fromValue(String) - Static method in enum com.ansys.ingress.client.api.transfers.TransferEvent.Reason
  Gets a `TransferEvent.Reason` from a string value.
FTC_USER_TYPE - Static variable in class com.ansys.ingress.client.api.Credentials
  FTC_USER_TYPE
FULL_CONTROL_ACTION - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  FULL_CONTROL_ACTION specifies the permission for full control on an object in the repository.
FULL_MY_DATA_PATH - Static variable in interface com.ansys.ingress.client.api.DataManager
  The full path to the user's "My Data" folder.

## G

genericCall(String, String, Variant) - Method in interface com.ansys.ingress.client.api.DataManager
  Deprecated.
getActiveUri() - Method in class com.ansys.ingress.client.api.ConnectionDetails
  The URI of the object the user is currently accessing in a browser or null if the user is not currently using a browser.
getAdministrationManager() - Method in interface com.ansys.ingress.client.api.Connection
  Gets the object for this connection that provides access to administration operations.
GetAllJobInformation() - Method in interface com.ansys.ingress.client.api.JobManager
getAttribute() - Method in class com.ansys.ingress.client.api.search.QueryRow
getAvailableWorkspaces() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getBaseTypeName() - Method in interface com.ansys.ingress.client.api.ModelObject
getBaseTypeName() - Method in interface com.ansys.ingress.client.api.ModelSpec
getBundlePackage() - Method in exception com.ansys.ingress.client.api.EkmException
getCacheid() - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Gets the value of the cacheid property.
getCacheId() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
getCacheServer() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getCacheServerPort() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getCacheServerProtocol() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getCacheServerUrl() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getCacheStatus(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Gets the status of a file transfer that is using an EKM cache server.
getCause() - Method in class com.ansys.ingress.client.api.schema.ConnectorEventError
  Gets the value of the cause property.
getChanges(String, String, TransferEventListener) - Method in interface com.ansys.ingress.client.api.DataManager
  Retrieves differences between local copy of files and folders on the user's machine with coresponding files and folders on the EKM server.
getCheckinStatus() - Method in interface com.ansys.ingress.client.api.ModelObject
getChild(String) - Method in interface com.ansys.ingress.client.api.ModelObject
  Gets the child with the specified name.
getChildNames() - Method in interface com.ansys.ingress.client.api.ModelObject
getChildren() - Method in interface com.ansys.ingress.client.api.ModelObject
GetClusterConfigurations() - Method in interface com.ansys.ingress.client.api.JobManager
GetClusterConfigurationsWithInformation() - Method in interface com.ansys.ingress.client.api.JobManager
getComment() - Method in class com.ansys.ingress.client.api.VersionHistoryItem
getComparatorInstance() - Method in class com.ansys.ingress.client.api.search.RepositorySearch
getConcreteTypeNames() - Static method in class com.ansys.ingress.client.api.ModelSpecUtils
  Gets the concrete type names that are defined.
getConcreteTypes() - Method in interface com.ansys.ingress.client.api.DataManager
  Gets the concrete types (types that can be created by a user) defined on the EKM server.
getCondition() - Method in class com.ansys.ingress.client.api.search.QueryRow
GetConfiguredQueues() - Method in interface com.ansys.ingress.client.api.JobManager
getConnection(String) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Gets the connection with the specified name.
getConnection() - Method in interface com.ansys.ingress.client.api.DataManager
  Gets the Connection associated with this DataManager.
getConnectionDetails(String) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Gets information about a specific connection.
getConnectionNames() - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Gets the names of all connections saved on this computer.
getConnections() - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Gets information about all of the connections currently available.
getController() - Method in class com.ansys.ingress.client.api.schema.ConnectorRequest
  Gets the value of the controller property.
getCurrentUsersUnitSystem() - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Gets the current unit system being used by this user on the EKM server.
getDataManager() - Method in interface com.ansys.ingress.client.api.Connection
  Gets the object for this connection that provides access to data management operations.
getDataManager() - Method in interface com.ansys.ingress.client.api.ModelObject
getDate() - Method in class com.ansys.ingress.client.api.VersionHistoryItem
getDefaultLocale() - Static method in class com.ansys.ingress.client.api.utils.Localizer
  Gets an instance of localizer for the given package and the default locale.
getDescription() - Method in class com.ansys.ingress.client.api.CacheStatus
getDescription() - Method in interface com.ansys.ingress.client.api.ModelObject
getDetails() - Method in interface com.ansys.ingress.client.api.Connection
getDisplayName() - Method in interface com.ansys.ingress.client.api.ModelObject
getDownloadedFile() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
  Returns the value of the downloadedFile.
getDownloadedFilePath() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
  Returns the value of the downloadedFilePath.
getEkmDataDirectory() - Static method in class com.ansys.ingress.client.api.utils.PathUtils
getEkmSessionId() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getEndTime() - Method in class com.ansys.ingress.client.api.CacheStatus
getError() - Method in class com.ansys.ingress.client.api.CacheStatus
getError() - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Gets the value of the error property.
getError() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
getException() - Method in class com.ansys.ingress.client.api.schema.ConnectorEventError
  Gets the value of the exception property.
getException() - Method in class com.ansys.ingress.client.api.schema.ConnectorResponse
  Gets the value of the exception property.
getException() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent.Error
getExceptionClass() - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Gets the value of the exceptionClass property.
getExceptionMessage() - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Gets the value of the exceptionMessage property.
getFailedItems() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent.Error
getFailures() - Method in class com.ansys.ingress.client.api.schema.ConnectorEventError
  Gets the value of the failures property.
getFailures() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent.Error
getHttpSessionId() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getID() - Method in interface com.ansys.ingress.client.api.ModelObject
getInstance(Locale) - Static method in class com.ansys.ingress.client.api.utils.Localizer
  Gets an instance of localizer for the given package and locale.
getInstance(String) - Static method in class com.ansys.ingress.client.api.utils.Localizer
  Gets an instance of localizer for the given language.
GetJobConclusionInformation(String, String) - Method in interface com.ansys.ingress.client.api.JobManager
  Gets information about a job after the job has completed This method must be used after FinalizeJob has been called and before ReleaseJob is called
GetJobInformation(String) - Method in interface com.ansys.ingress.client.api.JobManager
GetJobLog(String, String, String, String) - Method in interface com.ansys.ingress.client.api.JobManager
getJobManager() - Method in interface com.ansys.ingress.client.api.Connection
  Gets the object for this connection that provides access to job management operations.
GetJobs(String) - Method in interface com.ansys.ingress.client.api.JobManager
GetJobStatus(String, String, String) - Method in interface com.ansys.ingress.client.api.JobManager
GetJobStatuses(String, String, boolean) - Method in interface com.ansys.ingress.client.api.JobManager
  Get statuses for a list of jobs
getLabel() - Method in interface com.ansys.ingress.client.api.ModelSpec
getLastConnectionError() - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Gets the last error that occurred related to connections.
getLastModified() - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Gets the value of the lastModified property.
getLastModified() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
  Returns the value of the lastModified.
getLinuxProgramPath(String) - Static method in class com.ansys.ingress.client.api.utils.Platform
  Executes which to locate the application specified by name.
getListing(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Gets a list of the file and container objects that are children of the object at the specified path.
getListing(String, Set<String>, Set<String>) - Method in interface com.ansys.ingress.client.api.DataManager
  Gets a list of the specified object types that are children of the object at the specified path.
getLocale() - Method in interface com.ansys.ingress.client.api.Connection
getLocale() - Method in class com.ansys.ingress.client.api.utils.Localizer
getLocalPath() - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Gets the value of the localPath property.
getLocation() - Method in interface com.ansys.ingress.client.api.Connection
  Gets the location of the EKM server associated with this connection.
getLocation() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getMatch() - Method in class com.ansys.ingress.client.api.search.QueryOperation
getMessage() - Method in exception com.ansys.ingress.client.api.EkmException
getMessage() - Method in exception com.ansys.ingress.client.api.InvalidCredentialsException
getMessage() - Method in exception com.ansys.ingress.client.api.InvalidWorkspaceException
getMessage() - Method in exception com.ansys.ingress.client.api.NoLicenseAvailableException
getMessage() - Method in class com.ansys.ingress.client.api.schema.ConnectorEventError
  Gets the value of the message property.
getMessage() - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Gets the value of the message property.
getMessage() - Method in exception com.ansys.ingress.client.api.TooManySessionsException
getMessage() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent.Error
getModelSpecs() - Method in interface com.ansys.ingress.client.api.DataManager
  Retrieves the object types supported by the EKM server.
getModificationTime() - Method in interface com.ansys.ingress.client.api.ModelObject
getModifiedBy() - Method in interface com.ansys.ingress.client.api.ModelObject
getMyDataFolder(String) - Static method in class com.ansys.ingress.client.api.utils.PathUtils
  Gets the path to the current user's "My Data" folder.
getName() - Method in interface com.ansys.ingress.client.api.Connection
  Gets the name of this workspace if it has been previously saved.
getName() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getName() - Method in interface com.ansys.ingress.client.api.ModelObject
getObjectUrl(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Returns the URL to an object in the repository.
getOp() - Method in class com.ansys.ingress.client.api.search.Query
  Gets the query's operation object.
getOperation() - Method in class com.ansys.ingress.client.api.schema.ConnectorRequest
  Gets the value of the operation property.
getParameters() - Method in class com.ansys.ingress.client.api.schema.ConnectorRequest
  Gets the value of the parameters property.
getParent() - Method in interface com.ansys.ingress.client.api.ModelObject
getParentPath() - Method in interface com.ansys.ingress.client.api.ModelObject
getPassword() - Method in interface com.ansys.ingress.client.api.Connection
  Gets the password of the user.
getPassword() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getPassword() - Method in class com.ansys.ingress.client.api.Credentials
getPasswordAuthentication() - Method in class com.ansys.ingress.client.api.utils.HttpAuthenticator
getPath() - Method in interface com.ansys.ingress.client.api.ModelObject
getPath() - Method in class com.ansys.ingress.client.api.search.Query
  Gets the path being searched.
getPercentComplete() - Method in class com.ansys.ingress.client.api.CacheStatus
getPercentComplete(JobEvent) - Method in class com.ansys.ingress.client.api.transfers.TransferMonitor
  Calculates percent complete from the event.
getPreference(String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Gets a user's preference value.
getPreferences() - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Gets all of a user's preferences.
getProgress() - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Gets the value of the progress property.
getProgress() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
getProperties() - Method in interface com.ansys.ingress.client.api.ModelObject
getProperties() - Method in interface com.ansys.ingress.client.api.ModelSpec
getProperty(String) - Method in interface com.ansys.ingress.client.api.ModelObject
  Retrieves a property of this object.
getPropertySpec(String) - Method in interface com.ansys.ingress.client.api.ModelObject
  Gets the property specfication for the specified property name.
getPropertySpecs() - Method in interface com.ansys.ingress.client.api.ModelSpec
GetQueues(String) - Method in interface com.ansys.ingress.client.api.JobManager
getReason() - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Gets the value of the reason property.
getReason() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
getRemotePath() - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Gets the value of the remotePath property.
getRequiredChildren() - Method in interface com.ansys.ingress.client.api.ModelSpec
getRootCause() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent.Error
getRootCauseClass() - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Gets the value of the rootCauseClass property.
getRootCauseMessage() - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Gets the value of the rootCauseMessage property.
getRows() - Method in class com.ansys.ingress.client.api.search.QueryOperation
GetRsmVersion() - Method in interface com.ansys.ingress.client.api.JobManager
  Returns the internal RSM version number.
getSearchable() - Method in interface com.ansys.ingress.client.api.ModelSpec
getServerErrorDetails() - Method in exception com.ansys.ingress.client.api.EkmException
  Dumps out error information from the server.
getServerErrorMessage() - Method in exception com.ansys.ingress.client.api.EkmException
  Returns the value of the serverErrorMessage.
getServerException() - Method in exception com.ansys.ingress.client.api.EkmException
  Returns the value of the serverException.
getServerRootCause() - Method in exception com.ansys.ingress.client.api.EkmException
  Returns the value of the serverRootCause.
getServerRootCauseMessage() - Method in exception com.ansys.ingress.client.api.EkmException
  Returns the value of the serverRootCauseMessage.
getServerStackTrace() - Method in exception com.ansys.ingress.client.api.EkmException
  Returns the value of the serverStackTrace.
getServerTime() - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Retrieves the date and time from the server.
getSource() - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Gets the value of the source property.
getSpec() - Method in interface com.ansys.ingress.client.api.ModelObject
getSpecFromTypeName(String) - Static method in class com.ansys.ingress.client.api.ModelSpecUtils
  Gets an object type for the given type name.
getStacktrace() - Method in class com.ansys.ingress.client.api.schema.ConnectorEventError
  Gets the value of the stacktrace property.
getStackTrace() - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Gets the value of the stackTrace property.
getStackTrace() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent.Error
getStackTrace(Throwable) - Method in class com.ansys.ingress.client.api.transfers.TransferMonitor
  Dumps a stack trace into a string.
getStartTime() - Method in class com.ansys.ingress.client.api.CacheStatus
getStatus() - Method in class com.ansys.ingress.client.api.CacheStatus
getStatusCode() - Method in exception com.ansys.ingress.client.api.EkmException
  Returns the value of the statusCode.
getString(String, Object...) - Method in class com.ansys.ingress.client.api.utils.Localizer
  Gets a localized string.
getSubExpressions() - Method in class com.ansys.ingress.client.api.search.QueryOperation
getSubTypeNames(String) - Static method in class com.ansys.ingress.client.api.ModelSpecUtils
  Gets the subtypes of the specified type.
getSuperTypeNames(String) - Static method in class com.ansys.ingress.client.api.ModelSpecUtils
  Gets the set of supertypes for the given type.
getSupportedLocales() - Static method in class com.ansys.ingress.client.api.utils.Localizer
getTaskName() - Method in class com.ansys.ingress.client.api.CacheStatus
getToken() - Method in class com.ansys.ingress.client.api.Credentials
getTotalBytesCached(Set<ContentManifestEntryData>) - Method in interface com.ansys.ingress.client.api.DataManager
  Get the total number of bytes cached on the cache server for the given items.
getType() - Method in class com.ansys.ingress.client.api.search.Query
  Gets the type of this query.
getTypeAttributeValue(String) - Method in interface com.ansys.ingress.client.api.ModelSpec
  Gets the value of an attribute of a type.
getTypeName() - Method in interface com.ansys.ingress.client.api.ModelObject
getTypeName() - Method in interface com.ansys.ingress.client.api.ModelSpec
getTypename() - Method in class com.ansys.ingress.client.api.search.QueryRow
getUnitForPropertySpec(PropertySpec) - Static method in class com.ansys.ingress.client.api.ModelSpecUtils
  Gets the unit for the given proprty.
getUnits() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getUnitSystemName() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getUserArchiveId() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getUsername() - Method in interface com.ansys.ingress.client.api.Connection
  Gets the EKM username associated with this connection.
getUsername() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getUsername() - Method in class com.ansys.ingress.client.api.Credentials
getUsername() - Method in class com.ansys.ingress.client.api.VersionHistoryItem
getUserToken() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getUserType() - Method in class com.ansys.ingress.client.api.Credentials
getValue() - Method in class com.ansys.ingress.client.api.schema.ConnectorResponse
  Gets the value of the value property.
getValue() - Method in class com.ansys.ingress.client.api.search.QueryRow
getVariantFactory() - Method in interface com.ansys.ingress.client.api.Connection
  Get the `VariantFactory` used by this connection.
getVersion() - Method in class com.ansys.ingress.client.api.VersionHistoryItem
getVersionHistory(ModelObject) - Method in interface com.ansys.ingress.client.api.DataManager
  Retrieves the version control history of the specified object from the EKM server.
getViewName() - Method in interface com.ansys.ingress.client.api.ModelObject
getViewPath() - Method in interface com.ansys.ingress.client.api.ModelObject
getWorkspace() - Method in interface com.ansys.ingress.client.api.Connection
  Gets the current EKM workspace being used by this connection.
getWorkspace() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getWorkspace() - Method in exception com.ansys.ingress.client.api.ConnectionException
getWorkspace() - Method in class com.ansys.ingress.client.api.Credentials
getWorkspaceConfig() - Method in class com.ansys.ingress.client.api.ConnectionDetails
getWorkspaces() - Method in interface com.ansys.ingress.client.api.Connection
  Gets the list of EKM workspaces available to the current user.
GROUPS_PATH - Static variable in interface com.ansys.ingress.client.api.DataManager
  The path to /System/User Accounts/Groups.

## H

hasChild(String) - Method in interface com.ansys.ingress.client.api.ModelObject
  Determines if this object has a child with the given name.
hasConnection(String) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Determines if a saved connection exists.
hasNext() - Method in class com.ansys.ingress.client.api.search.RepositorySearchResultIterator
hasPermission(ModelObject, Collection<PermissionAction>) - Method in interface com.ansys.ingress.client.api.DataManager
  Determines if the current user has permission to perform the specified actions on the given object.
hasPermission(String) - Method in interface com.ansys.ingress.client.api.ModelObject
  Determines if the current user has permission to perform the specified action.
hasSavedCredentials() - Method in interface com.ansys.ingress.client.api.Connection
  Determines if this connection has saved credentials or not.
hasSavedCredentials() - Method in class com.ansys.ingress.client.api.ConnectionDetails
HIDDEN_CATEGORY - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  HIDDEN_CATEGORY is the name of the property categroy for hidden properties.
HttpAuthenticator - Class in com.ansys.ingress.client.api.utils
  HttpAuthenticator is used to retrieve the credentials used for HTTP authentication.
HttpAuthenticator() - Constructor for class com.ansys.ingress.client.api.utils.HttpAuthenticator
  Creates a new instance of HttpAuthenticator.
HttpProxySelector - Class in com.ansys.ingress.client.api.utils
  HttpProxySelector is used to obtain the proxy servers used by HTTP communications.
HttpProxySelector() - Constructor for class com.ansys.ingress.client.api.utils.HttpProxySelector
  Creates a new instance of EkmProxySelector.
HttpProxySelector(ProxySelector) - Constructor for class com.ansys.ingress.client.api.utils.HttpProxySelector
  Creates a new instance of EkmProxySelector.

## I

ICON_ATTRIBUTE - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  ICON_ATTRIBUTE is the attribue for a type's icon
InquireJobByName(String, String, String, String) - Method in interface com.ansys.ingress.client.api.JobManager
InquireJobByTag(String, String, String, String) - Method in interface com.ansys.ingress.client.api.JobManager
InterruptJob(String, String, String) - Method in interface com.ansys.ingress.client.api.JobManager
InvalidCredentialsException - Exception in com.ansys.ingress.client.api
  InvalidCredentialsException indicates a user provided bad credentials when logging into EKM.
InvalidCredentialsException(String, String, ErrorInfo) - Constructor for exception com.ansys.ingress.client.api.InvalidCredentialsException
  Creates a new instance of InvalidCredentialsException.
InvalidWorkspaceException - Exception in com.ansys.ingress.client.api
  InvalidWorkspaceException indicates an invalid workspace was given when opening a connection to an EKM server.
InvalidWorkspaceException(String, String, ErrorInfo) - Constructor for exception com.ansys.ingress.client.api.InvalidWorkspaceException
  Creates a new instance of InvalidWorkspaceException.
isAdminUser() - Method in interface com.ansys.ingress.client.api.Connection
  Determines if the user associated with this connection is an admin user or not.
isAdminUser() - Method in class com.ansys.ingress.client.api.ConnectionDetails
isBeta() - Method in interface com.ansys.ingress.client.api.ModelSpec
isCheckedIn() - Method in interface com.ansys.ingress.client.api.ModelObject
isCheckedOut() - Method in interface com.ansys.ingress.client.api.ModelObject
isCheckinApplicable(ModelObject) - Method in interface com.ansys.ingress.client.api.DataManager
  Determines whether the specified object can be checked into version control.
isCloseExistingSession() - Method in class com.ansys.ingress.client.api.Credentials
isDataExtractionPending(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Determines if an object on the EKM server is currently having metadata extracted from it.
isFileType(ModelSpec) - Static method in class com.ansys.ingress.client.api.ModelSpecUtils
  Determines if the given type is a file type or not.
isFolder() - Method in interface com.ansys.ingress.client.api.ModelObject
isInternal() - Method in interface com.ansys.ingress.client.api.ModelObject
isInternal() - Method in interface com.ansys.ingress.client.api.ModelSpec
isLocked() - Method in interface com.ansys.ingress.client.api.ModelObject
isLoggedIn() - Method in interface com.ansys.ingress.client.api.Connection
  Determines if the user of this connection is still logged in or not.
isMixin() - Method in interface com.ansys.ingress.client.api.ModelSpec
isNoLicense() - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Gets the value of the noLicense property.
isOpen() - Method in interface com.ansys.ingress.client.api.Connection
  Determines if this connection is opened or not.
isOpen() - Method in class com.ansys.ingress.client.api.ConnectionDetails
isSaved() - Method in interface com.ansys.ingress.client.api.Connection
  Determines if this is a saved connection or not.
isSaved() - Method in class com.ansys.ingress.client.api.ConnectionDetails
isServerError() - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Gets the value of the serverError property.
isSessionValid() - Method in interface com.ansys.ingress.client.api.Connection
  Determines if the EKM session associated with this connection is still valid or not.
isTooManyConnections() - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Gets the value of the tooManyConnections property.
isUnderVersionControl() - Method in interface com.ansys.ingress.client.api.ModelObject
isUsingCache() - Method in interface com.ansys.ingress.client.api.DataManager
  Determines if transfers will use an EKM cache server or not.
isWindows() - Static method in class com.ansys.ingress.client.api.utils.Platform
  Determines if the application is executing on a Windows OS.
itemPath - Variable in class com.ansys.ingress.client.api.transfers.TransferEvent.FailedItem
  Item that failed

## J

JobException - Exception in com.ansys.ingress.client.api
  JobException is the exception thrown by operations defined in the `JobManager` interface.
JobException(Throwable) - Constructor for exception com.ansys.ingress.client.api.JobException
  Creates a new instance of JobException
JobException(JobException.Reason, Object...) - Constructor for exception com.ansys.ingress.client.api.JobException
JobException(JobException.Reason, Exception, Object...) - Constructor for exception com.ansys.ingress.client.api.JobException
  Creates a new instance of JobException.
JobException.Reason - Enum in com.ansys.ingress.client.api
  Reason defines the message keys for a `JobException`.
JobManager - Interface in com.ansys.ingress.client.api
  JobManager defines the interface for performing job management operations on an EKM server.

## L

lastModified - Variable in class com.ansys.ingress.client.api.schema.ConnectorEvent
LENGTH_PROPERTY - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  LENGTH_PROPERTY is the property containing the length of a file on the server.
LIFECYCLE_ACTION - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  LIFECYCLE_ACTION specifies the permission for performing a lifecycle operation on an object in the repository.
LIFECYCLE_CHANGED - Static variable in interface com.ansys.ingress.client.api.Subscriptions
  Event reason constant.
load(String) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Opens a saved connection to an EKM server using saved credentials.
load(String, boolean) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Loads a saved connectino.
load(String, String, String) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Opens a saved connection to an EKM server.
load(String, String, String, boolean) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Opens a saved connection to an EKM server.
load(String, ConnectionFactory.TokenUserType, String) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Opens a persisted connection to an EKM server.
Localizer - Class in com.ansys.ingress.client.api.utils
  Localizer is used to get localized strings.
Localizer(Locale) - Constructor for class com.ansys.ingress.client.api.utils.Localizer
  Creates a new instance of Localizer.
Localizer(Locale, String) - Constructor for class com.ansys.ingress.client.api.utils.Localizer
  Creates a new instance of Localizer.
localPath - Variable in class com.ansys.ingress.client.api.schema.ConnectorEvent
lock(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Locks an object for exclusive use by the current user.
lock(String, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Locks an object for exclusive use by the current user.
LOCKING_ENABLED_OPTION - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  LOCKING_ENABLED_OPTION is used to determine if locking is enabled on an object.
logDownload(List<String>) - Method in interface com.ansys.ingress.client.api.DataManager
  Logs downloads on the server.

## M

message - Variable in class com.ansys.ingress.client.api.schema.ConnectorEventError
message - Variable in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
MESSAGE_ADDED - Static variable in interface com.ansys.ingress.client.api.Subscriptions
  Event reason constant for message object added (to __discussions__ child of model object) subscription
ModelObject - Interface in com.ansys.ingress.client.api
  ModelObject represents an object in the EKM repository.
ModelSpec - Interface in com.ansys.ingress.client.api
  ModelSpec provides information about object types defined in EKM.
ModelSpecUtils - Class in com.ansys.ingress.client.api
  ModelSpecUtils is used to get information about EKM object types.
ModelSpecUtils() - Constructor for class com.ansys.ingress.client.api.ModelSpecUtils
MODIFICATION_TIME_PROPERTY - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  MODIFICATION_TIME_PROPERTY is the property containing the date and time a an object on the server was last modified
MODIFIED_BY_PROPERTY - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  MODIFIED_BY_PROPERTY is the property containing the name of the user that last modified an object.
MODIFY_ACTION - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  MODIFY_ACTION specifies the permission for modifying an object in the repository.
move(String, String) - Method in interface com.ansys.ingress.client.api.DataManager
  Moves the object at the source path to the object at the destination path.
MY_DATA_PATH - Static variable in interface com.ansys.ingress.client.api.DataManager
  The partial path to the user's "My Data" folder.
MY_SAVED_QUERIES - Static variable in interface com.ansys.ingress.client.api.DataManager
  The path to the user's saved queries folder.

## N

next() - Method in class com.ansys.ingress.client.api.search.RepositorySearchResultIterator
noLicense - Variable in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
NoLicenseAvailableException - Exception in com.ansys.ingress.client.api
  NoLicenseAvailableException indicates not licenses are available for a user when logging into EKM.
NoLicenseAvailableException(String, String, ErrorInfo) - Constructor for exception com.ansys.ingress.client.api.NoLicenseAvailableException
  Creates a new instance of NoLicenseAvailableException.
NOT_FOUND - Static variable in class com.ansys.ingress.client.api.CacheStatus
  NOT_FOUND - no status exists for the given ID.

## O

ObjectFactory - Class in com.ansys.ingress.client.api.schema
  This object contains factory methods for each Java content interface and Java element interface generated in the com.ansys.ingress.client.api.schema package.
ObjectFactory() - Constructor for class com.ansys.ingress.client.api.schema.ObjectFactory
  Create a new ObjectFactory that can be used to create new instances of schema derived classes for package: com.ansys.ingress.client.api.schema
open(String, String, String) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Opens a connection to an EKM server.
open(String, String, String, Locale) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Opens a connection to an EKM server.
open(String, String, String, String) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Opens a connection to an EKM server.
open(String, String, String, String, Locale) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Opens a connection to an EKM server.
open(String, String, String, String, Locale, boolean) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Opens a connection to an EKM server.
open(String, ConnectionFactory.TokenUserType, String, String) - Static method in class com.ansys.ingress.client.api.ConnectionFactory
  Opens a connection to an EKM server.
operation - Variable in class com.ansys.ingress.client.api.schema.ConnectorRequest

## P

packages - Variable in class com.ansys.ingress.client.api.utils.Localizer
parameters - Variable in class com.ansys.ingress.client.api.schema.ConnectorRequest
PASSWORD_CHANGED - Static variable in interface com.ansys.ingress.client.api.Subscriptions
  Event reason constant.
PATH_SEPARATOR - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  PATH_SEPARATOR is the value used to separate path elements.
PathUtils - Class in com.ansys.ingress.client.api.utils
  PathUtils provides methods to manipulate and query EKM repository paths.
PathUtils() - Constructor for class com.ansys.ingress.client.api.utils.PathUtils
PDM_USER_TYPE - Static variable in class com.ansys.ingress.client.api.Credentials
  PDM_USER_TYPE needs to be kept in sync with core AuthenticationToken.PDM_USER_TYPE.
PerformDiagnosticOperation(String, String, String) - Method in interface com.ansys.ingress.client.api.JobManager
  Performs a diagnostic operation
PermissionAction - Enum in com.ansys.ingress.client.api
  Action defines the actions that can be used to determine if a user has permission to perform an action on an object.
Platform - Class in com.ansys.ingress.client.api.utils
  Platform contains methods for interacting with the platform where a client is running.
Platform() - Constructor for class com.ansys.ingress.client.api.utils.Platform
progress - Variable in class com.ansys.ingress.client.api.schema.ConnectorEvent
PROPERTY_CHANGED - Static variable in interface com.ansys.ingress.client.api.Subscriptions
  Event reason constant.

## Q

Query - Class in com.ansys.ingress.client.api.search
  Query represents a complex query that is performed in an EKM repository.
Query() - Constructor for class com.ansys.ingress.client.api.search.Query
  Creates a new instance of Query.
Query(String) - Constructor for class com.ansys.ingress.client.api.search.Query
  Creates a new instance of Query.
QueryMatch - Enum in com.ansys.ingress.client.api.search
  QueryMatch defines whether ALL query rows must be matched when executing a query or ANY query rows may match.
QueryOperation - Class in com.ansys.ingress.client.api.search
  QueryOperation is the data used to query for objects on the EKM server.
QueryOperation() - Constructor for class com.ansys.ingress.client.api.search.QueryOperation
QueryRow - Class in com.ansys.ingress.client.api.search
  QueryRow is a specific part of a query used to find an object on the EKM server.
QueryRow() - Constructor for class com.ansys.ingress.client.api.search.QueryRow

## R

reason - Variable in class com.ansys.ingress.client.api.schema.ConnectorEvent
reason - Variable in class com.ansys.ingress.client.api.transfers.TransferEvent.FailedItem
  Reason for failure
ReleaseJob(String, String, String, String) - Method in interface com.ansys.ingress.client.api.JobManager
remotePath - Variable in class com.ansys.ingress.client.api.schema.ConnectorEvent
removeCacheStatus(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Removes status information from an EKM cache server.
removeFromVersionControl(ModelObject) - Method in interface com.ansys.ingress.client.api.DataManager
  Removes an object and all of its children from version control.
removeFromVersionControl(ModelObject, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Removes an object from version control.
removeProperty(String) - Method in interface com.ansys.ingress.client.api.ModelObject
  Removes a property from this object.
removeSubgroups(List<String>, String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Removes subgroups from a group.
removeUsersFromGroup(List<String>, String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Removes users from a group.
REPOSITORY_PATH - Static variable in class com.ansys.ingress.client.api.utils.PathUtils
  Path to primary folder in the repository.
RepositorySearch - Class in com.ansys.ingress.client.api.search
  RepositorySearch is a search executed on the EKM server.
RepositorySearch() - Constructor for class com.ansys.ingress.client.api.search.RepositorySearch
RepositorySearchResult - Class in com.ansys.ingress.client.api.search
  RepositorySearchResult represents a single result from a search executed on the EKM repository.
RepositorySearchResult() - Constructor for class com.ansys.ingress.client.api.search.RepositorySearchResult
RepositorySearchResultComparator - Class in com.ansys.ingress.client.api.search
  RepositorySearchResultComparator is used to compare two search results.
RepositorySearchResultComparator() - Constructor for class com.ansys.ingress.client.api.search.RepositorySearchResultComparator
RepositorySearchResultIterator - Class in com.ansys.ingress.client.api.search
  RepositorySearchResultIterator is an iterator to support iterating over search results.
RepositorySearchResultIterator() - Constructor for class com.ansys.ingress.client.api.search.RepositorySearchResultIterator
resetCredentials() - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Resets the details back to an unitialized state.
restoreRecycleBin(List<String>) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Restores the data in the user's recycle bin on the EKM server to its original locations.
rootCauseClass - Variable in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
rootCauseMessage - Variable in class com.ansys.ingress.client.api.schema.ConnectorExceptionData

## S

save() - Method in interface com.ansys.ingress.client.api.Connection
  Saves this connection so that it can be opened at a later time.
save(boolean) - Method in interface com.ansys.ingress.client.api.Connection
  Saves this connection so that it can be opened at a later time.
save(String) - Method in interface com.ansys.ingress.client.api.Connection
  Saves this connection so that it can be opened at a later time.
save(String, boolean) - Method in interface com.ansys.ingress.client.api.Connection
  Saves this connection so that it can be opened at a later time.
select(URI) - Method in class com.ansys.ingress.client.api.utils.HttpProxySelector
semaphore - Variable in class com.ansys.ingress.client.api.transfers.TransferMonitor
sendChanges(String, String, List<String>, TransferEventListener) - Method in interface com.ansys.ingress.client.api.DataManager
  Sends differences between local copies of files and folders on the user's computer with coresponding files and folders on the EKM server.
sendChanges(String, String, List<String>, TransferEventListener, boolean, String) - Method in interface com.ansys.ingress.client.api.DataManager
  Sends differences between local copies of files and folders on the user's computer with coresponding files and folders on the EKM server.
sendChanges(String, String, List<String>, TransferEventListener, boolean, String, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Sends differences between local copies of files and folders on the user's computer with coresponding files and folders on the EKM server.
serialize() - Method in class com.ansys.ingress.client.api.search.Query
  Serializes this query into a string.
serializeModelObject(ModelObject) - Method in interface com.ansys.ingress.client.api.DataManager
  Serializes a ModelObject instance into XML.
serializeModelObject(ModelObject, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Serializes a ModelObject instance into XML.
serializeModelSpec(ModelSpec) - Method in interface com.ansys.ingress.client.api.DataManager
  Serializes a ModelSpec instance into XML.
serverError - Variable in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
setActiveUri(String) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the value of the activeUri.
setAdminUser(boolean) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the flag indicating if this is an admin user or not.
setAllowChildBasedSearch(boolean) - Method in class com.ansys.ingress.client.api.search.QueryOperation
setAllowSubExpressionSearch(boolean) - Method in class com.ansys.ingress.client.api.search.QueryOperation
setAttribute(String) - Method in class com.ansys.ingress.client.api.search.QueryRow
setCacheid(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Sets the value of the cacheid property.
setCacheId(String) - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
  Sets the cache job ID used to get cache status.
setCacheServer(String) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the value of the cacheServer.
setCacheServerPort(int) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the value of the cacheServerPort.
setCacheServerProtocol(String) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the protocol used by the EKM cache server.
setCause(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorEventError
  Sets the value of the cause property.
setCloseExistingSession(boolean) - Method in class com.ansys.ingress.client.api.Credentials
  Sets the flag indicacting if existing sessions should be closed or not.
setComment(String) - Method in class com.ansys.ingress.client.api.VersionHistoryItem
  Sets the comment.
setCondition(Condition) - Method in class com.ansys.ingress.client.api.search.QueryRow
setController(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorRequest
  Sets the value of the controller property.
setDataManager(DataManager) - Static method in class com.ansys.ingress.client.api.ModelSpecUtils
  Initializes the `DataManager`.
setDate(Date) - Method in class com.ansys.ingress.client.api.VersionHistoryItem
  Sets the date.
setDescription(String) - Method in class com.ansys.ingress.client.api.CacheStatus
  Sets the description of the transfer.
setDescription(String) - Method in interface com.ansys.ingress.client.api.ModelObject
  Sets the description of this object.
setDownloadedFile(String) - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
  Sets the file that was downloaded
setDownloadedFilePath(String) - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
  Sets the path of a downloaded file.
setEkmSessionId(String) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the ID of the EKM session associated with this connection.
setEndTime(Date) - Method in class com.ansys.ingress.client.api.CacheStatus
  Sets the time when the transfer completed.
setError(String) - Method in class com.ansys.ingress.client.api.CacheStatus
  Sets the error message for a failed transfer.
setError(ConnectorEventError) - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Sets the value of the error property.
setError(TransferEvent.Error) - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
  Sets the error that caused the transfer to fail.
setException(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorEventError
  Sets the value of the exception property.
setException(ConnectorExceptionData) - Method in class com.ansys.ingress.client.api.schema.ConnectorResponse
  Sets the value of the exception property.
setException(Throwable) - Method in class com.ansys.ingress.client.api.transfers.TransferEvent.Error
  Sets the exception that caused the error.
setExceptionClass(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Sets the value of the exceptionClass property.
setExceptionMessage(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Sets the value of the exceptionMessage property.
setFailures(List<String>) - Method in class com.ansys.ingress.client.api.transfers.TransferEvent.Error
  Sets the list of files and folders that were not transferred due to errors.
setHttpSessionId(String) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the ID of the HTTP session associated with this connection.
setLastModified(XMLGregorianCalendar) - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Sets the value of the lastModified property.
setLastModified(String) - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
  Sets the value of the lastModified.
setLocale(Locale) - Method in class com.ansys.ingress.client.api.utils.Localizer
  Sets the locale used by this localizer.
setLocalPath(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Sets the value of the localPath property.
setLocation(URI) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the location of the EKM server associated with a connectino.
setMatch(QueryMatch) - Method in class com.ansys.ingress.client.api.search.QueryOperation
setMessage(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorEventError
  Sets the value of the message property.
setMessage(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Sets the value of the message property.
setName(String) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the name of the connection.
setNoLicense(boolean) - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Sets the value of the noLicense property.
setOp(QueryOperation) - Method in class com.ansys.ingress.client.api.search.Query
  Sets the query's operation.
setOpen(boolean) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the flag indicating if this connection is opened or not.
setOperation(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorRequest
  Sets the value of the operation property.
setParameters(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorRequest
  Sets the value of the parameters property.
setPassword(char[]) - Method in class com.ansys.ingress.client.api.Credentials
  Sets the password.
setPassword(char[]) - Method in class com.ansys.ingress.client.api.utils.HttpAuthenticator
  Sets the password.
setPath(String) - Method in class com.ansys.ingress.client.api.search.Query
  Sets the path that this query will search.
setPath(String) - Method in class com.ansys.ingress.client.api.search.RepositorySearch
  Sets the path to be searched.
setPercentComplete(int) - Method in class com.ansys.ingress.client.api.CacheStatus
  Sets the percentage of the transfer that is complete.
setPreference(String, String) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Sets a user preference.
setPreferences(Map<String, String>) - Method in interface com.ansys.ingress.client.api.AdministrationManager
  Sets a user's preferences.
setProgress(Integer) - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Sets the value of the progress property.
setProgress(int) - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
  Sets the current progress of the transfer as an integer between 0 up to and including 100.
setProperty(String, Variant) - Method in interface com.ansys.ingress.client.api.ModelObject
  Sets a property's value in this object.
setReason(ConnectorEventReason) - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Sets the value of the reason property.
setReason(TransferEvent.Reason) - Method in class com.ansys.ingress.client.api.transfers.TransferEvent
  Sets the reason for the event.
setRemotePath(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Sets the value of the remotePath property.
setRootCauseClass(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Sets the value of the rootCauseClass property.
setRootCauseMessage(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Sets the value of the rootCauseMessage property.
setRows(List<QueryRow>) - Method in class com.ansys.ingress.client.api.search.QueryOperation
setSaved(boolean) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets flag indicating if this is a saved connection or not.
setSavedCredentials(boolean) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets flag indicating this connection has saved credentials.
setSemaphore(ThreadEvent) - Method in class com.ansys.ingress.client.api.transfers.TransferMonitor
  Sets the semaphore used to notify interested parties when the transfer is completed or cached.
setServerError(boolean) - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Sets the value of the serverError property.
setServerErrorMessage(String) - Method in exception com.ansys.ingress.client.api.EkmException
  Sets the error message received from the server.
setServerException(String) - Method in exception com.ansys.ingress.client.api.EkmException
  Sets the class name of the exception that occurred on the server.
setServerRootCause(String) - Method in exception com.ansys.ingress.client.api.EkmException
  Sets the class name of the root cause exception that caused the error on the server.
setServerRootCauseMessage(String) - Method in exception com.ansys.ingress.client.api.EkmException
  Sets the error message of the root cause.
setServerStackTrace(String) - Method in exception com.ansys.ingress.client.api.EkmException
  Sets the stack trace of the error from the server.
setSource(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorEvent
  Sets the value of the source property.
setStacktrace(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorEventError
  Sets the value of the stacktrace property.
setStackTrace(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Sets the value of the stackTrace property.
setStartTime(Date) - Method in class com.ansys.ingress.client.api.CacheStatus
  Sets the time when the transfer started.
setStatus(int) - Method in class com.ansys.ingress.client.api.CacheStatus
  Sets the status of the transfer.
setStatusCode(int) - Method in exception com.ansys.ingress.client.api.EkmException
  Sets the HTTP status code associated with this error.
setSubExpressions(List<QueryOperation>) - Method in class com.ansys.ingress.client.api.search.QueryOperation
setTaskName(String) - Method in class com.ansys.ingress.client.api.CacheStatus
  Sets the current task name being executed by the cache server.
setToken(String) - Method in class com.ansys.ingress.client.api.Credentials
  Sets the token used for authentication.
setTooManyConnections(boolean) - Method in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
  Sets the value of the tooManyConnections property.
setTypename(String) - Method in class com.ansys.ingress.client.api.search.QueryRow
setUnits(Units) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the units system for this connection.
setUnitSystemName(String) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the unit system name for the user
setUserArchiveId(String) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the unique ID of this user.
setUsername(String) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the name of the user associated with a connectino.
setUsername(String) - Method in class com.ansys.ingress.client.api.Credentials
  Sets the username.
setUsername(String) - Method in class com.ansys.ingress.client.api.utils.HttpAuthenticator
  Sets the username.
setUsername(String) - Method in class com.ansys.ingress.client.api.VersionHistoryItem
  Sets the username.
setUserProperty(String, String, Variant) - Method in interface com.ansys.ingress.client.api.ModelObject
  Sets a user-defined property in this object.
setUserToken(String) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the token that can be used to authenticate with the EKM server.
setUserType(int) - Method in class com.ansys.ingress.client.api.Credentials
  Sets the user type if doing token-based authentication.
setValue(String) - Method in class com.ansys.ingress.client.api.schema.ConnectorResponse
  Sets the value of the value property.
setValue(Variant) - Method in class com.ansys.ingress.client.api.search.QueryRow
setVersion(String) - Method in class com.ansys.ingress.client.api.VersionHistoryItem
  Sets the version number of the item
setWorkspace(String) - Method in interface com.ansys.ingress.client.api.Connection
  Sets the EKM workspace to be used by this connection.
setWorkspace(String) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the workspace being used by this connection.
setWorkspace(String) - Method in exception com.ansys.ingress.client.api.ConnectionException
  Sets the workspace associated with this exception.
setWorkspace(String) - Method in class com.ansys.ingress.client.api.Credentials
  Sets the workspace.
setWorkspaceConfig(Document) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the XML document containing workspace configuration data.
setWorkspaces(List<String>) - Method in class com.ansys.ingress.client.api.ConnectionDetails
  Sets the workspaces available in this connection.
SHARED_DATA_PATH - Static variable in interface com.ansys.ingress.client.api.DataManager
  The path to the "Shared Data" folder.
SHARED_QUERIES_FOLDER - Static variable in interface com.ansys.ingress.client.api.DataManager
  The path to the shared queries folder.
source - Variable in class com.ansys.ingress.client.api.schema.ConnectorEvent
SPEC_TYPE_MIXIN - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  SPEC_TYPE_MIXIN indicates this type is a mixin type.
stacktrace - Variable in class com.ansys.ingress.client.api.schema.ConnectorEventError
stackTrace - Variable in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
startProgram(String, String, String...) - Static method in class com.ansys.ingress.client.api.utils.Platform
  Starts an application process.
SubmitJob(String, String, String, String, String, List<String>, int, String) - Method in interface com.ansys.ingress.client.api.JobManager
  Submit the job with jobSpaceId and RSM jobId to RSM.
Subscriptions - Interface in com.ansys.ingress.client.api
  Subscriptions defines the events that a user can be notified about.

## T

TAGS_CATEGORY - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  TAGS_CATEGORY is the category for user defined properties.
TERMINATE - Static variable in interface com.ansys.ingress.client.api.Subscriptions
  Event reason constant.
toInt() - Method in enum com.ansys.ingress.client.api.ConnectionFactory.TokenUserType
tooManyConnections - Variable in class com.ansys.ingress.client.api.schema.ConnectorExceptionData
TooManySessionsException - Exception in com.ansys.ingress.client.api
  TooManySessionsException indicates a user has too many sessions open with EKM.
TooManySessionsException(String, String, ErrorInfo) - Constructor for exception com.ansys.ingress.client.api.TooManySessionsException
  Creates a new instance of TooManySessionsException.
toString() - Method in enum com.ansys.ingress.client.api.AdministrationException.Reason
toString() - Method in enum com.ansys.ingress.client.api.ConnectionException.Reason
toString() - Method in class com.ansys.ingress.client.api.Credentials
toString() - Method in enum com.ansys.ingress.client.api.DataException.Reason
toString() - Method in enum com.ansys.ingress.client.api.EkmException.Reason
toString() - Method in exception com.ansys.ingress.client.api.EkmException
toString() - Method in enum com.ansys.ingress.client.api.JobException.Reason
toString() - Method in enum com.ansys.ingress.client.api.PermissionAction
toString() - Method in class com.ansys.ingress.client.api.transfers.TransferEvent.Error
transferCached(TransferEvent) - Method in class com.ansys.ingress.client.api.transfers.TransferEventAdapter
transferCached(TransferEvent) - Method in interface com.ansys.ingress.client.api.transfers.TransferEventListener
  Indicates a transfer has completed transferring files to the EKM cache server.
transferCanceled(TransferEvent) - Method in class com.ansys.ingress.client.api.transfers.TransferEventAdapter
transferCanceled(TransferEvent) - Method in interface com.ansys.ingress.client.api.transfers.TransferEventListener
  Indicates the transfer was canceled before completion.
transferCompleted(TransferEvent) - Method in class com.ansys.ingress.client.api.transfers.TransferEventAdapter
transferCompleted(TransferEvent) - Method in interface com.ansys.ingress.client.api.transfers.TransferEventListener
  Indicates a transfer completed successfully.
TransferEvent - Class in com.ansys.ingress.client.api.transfers
  TransferEvent is used to pass information to a `TransferEventListener` about the current state of a file transfer (upload or download).
TransferEvent(Object) - Constructor for class com.ansys.ingress.client.api.transfers.TransferEvent
  Creates a new instance of TransferEvent.
TransferEvent.Error - Class in com.ansys.ingress.client.api.transfers
  Error describes an error that occured during the transfer.
TransferEvent.FailedItem - Class in com.ansys.ingress.client.api.transfers
  FailedItem contains information about an item that was not successfully transferred.
TransferEvent.Reason - Enum in com.ansys.ingress.client.api.transfers
  Reason is the reason for the event.
TransferEventAdapter - Class in com.ansys.ingress.client.api.transfers
  TransferEventAdapter is an abstract adapter class for receiving `TransferEvent`s.
TransferEventAdapter() - Constructor for class com.ansys.ingress.client.api.transfers.TransferEventAdapter
TransferEventListener - Interface in com.ansys.ingress.client.api.transfers
  TransferEventListener is the interface that must be implemented to receive events from an EKM file transfer.
transferFailed(TransferEvent) - Method in class com.ansys.ingress.client.api.transfers.TransferEventAdapter
transferFailed(TransferEvent) - Method in interface com.ansys.ingress.client.api.transfers.TransferEventListener
  Indicates a transfer failed.
TransferMonitor - Class in com.ansys.ingress.client.api.transfers
  TransferMonitor is the base class for defining a class that monitors a file transfer.
TransferMonitor() - Constructor for class com.ansys.ingress.client.api.transfers.TransferMonitor
  Creates a new instance of TransferMonitorImpl.
transferProgress(TransferEvent) - Method in class com.ansys.ingress.client.api.transfers.TransferEventAdapter
transferProgress(TransferEvent) - Method in interface com.ansys.ingress.client.api.transfers.TransferEventListener
  Indicates progress has been reported by the transfer.
transferStarted(TransferEvent) - Method in class com.ansys.ingress.client.api.transfers.TransferEventAdapter
transferStarted(TransferEvent) - Method in interface com.ansys.ingress.client.api.transfers.TransferEventListener
  Indicates a transfer was started.

## U

undoCheckout(ModelObject) - Method in interface com.ansys.ingress.client.api.DataManager
  Restores an object, and all of its children, that was previously checked out from version control.
undoCheckout(ModelObject, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Restores an object that was previously checked out from version control.
unlock(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Unlocks an object that was previously locked for exclusive use.
unlock(String, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Unlocks an object that was previously locked for exclusive use.
updateAnalysisProject(String) - Method in interface com.ansys.ingress.client.api.DataManager
  Updates the Analysis Project object at the specified path.
updateModelObject(ModelObject) - Method in interface com.ansys.ingress.client.api.DataManager
  Updates the object on the EKM server.
updateSubscriptions(String, int) - Method in interface com.ansys.ingress.client.api.DataManager
  Updates the current user's notifications on the object at the specified path.
upload(List<String>, String, List<String>, TransferEventListener) - Method in interface com.ansys.ingress.client.api.DataManager
  Uploads files and folders from the user's computer to the destination folder on the EKM server.
upload(List<String>, String, List<String>, TransferEventListener, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Uploads files and folders from the user's computer to the destination folder on the EKM server.
upload(List<String>, String, List<String>, TransferEventListener, boolean, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Uploads files and folders from the user's computer to the destination folder on the EKM server.
upload(List<String>, String, List<String>, TransferEventListener, boolean, boolean, int) - Method in interface com.ansys.ingress.client.api.DataManager
  Uploads files and folders from the user's computer to the destination folder on the EKM server.
upload(List<String>, String, List<String>, TransferEventListener, boolean, boolean, int, boolean, boolean, String, boolean) - Method in interface com.ansys.ingress.client.api.DataManager
  Uploads files and folders from the user's computer to the destination folder on the EKM server.
upload(List<String>, String, List<String>, TransferEventListener, boolean, boolean, int, boolean, boolean, String, boolean, String) - Method in interface com.ansys.ingress.client.api.DataManager
  Uploads files and folders from the user's computer to the destination folder on the EKM server.
UploadFile(String, String, String, String) - Method in interface com.ansys.ingress.client.api.JobManager
  Upload a file from sourceLocalFilePath to the workingDirectory of the JobObject with id=jobSpaceId
useLanguageSettingsDotTxt(boolean) - Static method in class com.ansys.ingress.client.api.utils.Localizer
  Sets whether the localizer should use languagesetting.txt.
USER_ACCOUNTS_PATH - Static variable in interface com.ansys.ingress.client.api.DataManager
  The path to /System/User Accounts/Users.

## V

value() - Method in enum com.ansys.ingress.client.api.schema.ConnectorEventReason
value - Variable in class com.ansys.ingress.client.api.schema.ConnectorResponse
value() - Method in enum com.ansys.ingress.client.api.transfers.TransferEvent.Reason
valueOf(String) - Static method in enum com.ansys.ingress.client.api.AdministrationException.Reason
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ansys.ingress.client.api.ConnectionException.Reason
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ansys.ingress.client.api.ConnectionFactory.TokenUserType
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ansys.ingress.client.api.DataException.Reason
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ansys.ingress.client.api.EkmException.Reason
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ansys.ingress.client.api.JobException.Reason
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ansys.ingress.client.api.PermissionAction
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ansys.ingress.client.api.schema.ConnectorEventReason
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ansys.ingress.client.api.search.Condition
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ansys.ingress.client.api.search.QueryMatch
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ansys.ingress.client.api.transfers.TransferEvent.Reason
  Returns the enum constant of this type with the specified name.
values() - Static method in enum com.ansys.ingress.client.api.AdministrationException.Reason
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ansys.ingress.client.api.ConnectionException.Reason
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ansys.ingress.client.api.ConnectionFactory.TokenUserType
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ansys.ingress.client.api.DataException.Reason
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ansys.ingress.client.api.EkmException.Reason
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ansys.ingress.client.api.JobException.Reason
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ansys.ingress.client.api.PermissionAction
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ansys.ingress.client.api.schema.ConnectorEventReason
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ansys.ingress.client.api.search.Condition
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ansys.ingress.client.api.search.QueryMatch
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ansys.ingress.client.api.transfers.TransferEvent.Reason
  Returns an array containing the constants of this enum type, in the order they are declared.
VersionHistoryItem - Class in com.ansys.ingress.client.api
  VersionHistoryItem provides information about a specific version of an object in the EKM repository.
VersionHistoryItem() - Constructor for class com.ansys.ingress.client.api.VersionHistoryItem
VERSIONING_ENABLED_OPTION - Static variable in interface com.ansys.ingress.client.api.ModelSpec
  VERSIONING_ENABLED_OPTION is the property used to determine if an object has versioning enabled or not.

## W

WHICH - Static variable in class com.ansys.ingress.client.api.utils.Platform
WORKBENCH_PROJECT_ARCHIVE_EXT - Static variable in interface com.ansys.ingress.client.api.DataManager
  File extension for Workbench project archives (wbpz)
WORKBENCH_PROJECT_EXT - Static variable in interface com.ansys.ingress.client.api.DataManager
  File extension for Workbench projects (wbpj).

A B C D E F G H I J L M N O P Q R S T U V W