ELO Indexserver

https://www.forum.elo.com/javadoc/ix/25
Admin
ELO Indexserver provides a Java client API and middleware interface for accessing, managing, and...
Tokens:2,426
Snippets:47
Trust Score:9.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### IXServicePortIF.queryJobProtocol

Source: https://www.forum.elo.com/javadoc/ix/25/allclasses-index.html

Queries the protocol of a background job using the provided client information and query parameters.

```APIDOC
## IXServicePortIF.queryJobProtocol

### Description
Queries the protocol of a background job.

### Parameters
- **ClientInfo** (Object) - Required - Session and client context information.
- **QueryJobProtocolInfo** (Object) - Required - Parameters defining the job protocol query.

### Response
- **QueryJobProtocolResult** (Object) - The results from querying the protocol of a background thread.
```

--------------------------------

### IXServicePortIF

Source: https://www.forum.elo.com/javadoc/ix/25/allclasses-index.html

The primary interface for interacting with the Indexserver API.

```APIDOC
## IXServicePortIF

### Description
This is the main interface for the Indexserver API. It provides the methods required to communicate with the Indexserver service.
```

--------------------------------

### IXConnection

Source: https://www.forum.elo.com/javadoc/ix/25/allclasses-index.html

Represents a session connection to the Indexserver.

```APIDOC
## IXConnection

### Description
Represents a session connection to the Indexserver. Use IXConnFactory to create instances of this class.
```

--------------------------------

### IXServicePortIF.findSearchTerms

Source: https://www.forum.elo.com/javadoc/ix/25/allclasses-index.html

Retrieves alternative search terms based on the provided search information.

```APIDOC
## IXServicePortIF.findSearchTerms

### Description
Retrieves alternative search terms.

### Parameters
- **ClientInfo** (Object) - Required - Session and client context information.
- **FindInfo** (Object) - Required - Search criteria.
- **int** (Integer) - Required - Limit or configuration parameter.
```

--------------------------------

### IXServicePortIF.resolveRights

Source: https://www.forum.elo.com/javadoc/ix/25/allclasses-index.html

Resolves rights for a specific user based on the provided information.

```APIDOC
## IXServicePortIF.resolveRights

### Description
Resolves rights for a user.

### Parameters
- **ClientInfo** (Object) - Required - Session and client context information.
- **UserInfo** (Object) - Required - The user to resolve rights for.
- **ResolveRightsInfo** (Object) - Required - Configuration parameters for the rights resolution.

### Response
- **ResolveRightsResult** (Object) - The result of the rights resolution.
```

--------------------------------

### IXServicePortIF.restoreIcon

Source: https://www.forum.elo.com/javadoc/ix/25/allclasses-index.html

Restores an icon based on the provided recovery criteria.

```APIDOC
## IXServicePortIF.restoreIcon

### Description
Restores an icon.

### Parameters
- **ClientInfo** (Object) - Required - Session and client context information.
- **RestoreIconInfo** (Object) - Required - Recovery criteria for the icon.
- **LockZ** (Object) - Required - Unlock options.
```

--------------------------------

### Forward Workflow Node Replacement

Source: https://www.forum.elo.com/javadoc/ix/25/deprecated-list.html

Use this method as a replacement for the deprecated endEditWorkFlowNode function.

```java
#forwardWorkflowNode(ClientInfo, int, int, ForwardWorkflowNodeInfo, LockZ)
```

--------------------------------

### invalidateCache2

Source: https://www.forum.elo.com/javadoc/ix/25/allclasses-index.html

Invalidates the cache for the Indexserver. This operation uses InvalidateCacheInfo to specify parameters and returns an InvalidateCacheResult.

```APIDOC
## invalidateCache2

### Description
Invalidates the cache for the Indexserver. This operation requires an InvalidateCacheInfo object containing the necessary parameters.

### Parameters
- **InvalidateCacheInfo** (Object) - Required - Contains the parameters for the cache invalidation.

### Response
- **InvalidateCacheResult** (Object) - Contains the result of the cache invalidation call.
```
Tokens:
Raw