Retrieving Model Descriptions

This chapter describes methods provided by Infinity Process Platform to retrieve model descriptions on a deployed model. The class QueryService provides functionality to query the model repository.

Retrieving Description of a Specified Model

To retrieve the description of a specified model, use the following method:

DeployedModelDescription getModelDescription(long modelOID)

Parameter modelOID specifies the OID of the model to retrieve.

The method returns a DeployedModelDescription object. If no model with the specified OID exists, an ObjectNotFoundException is thrown. You need to have the permission to read model data to perform this method.

Retrieving Model Descriptions Satisfying Specified Criteria

The following method retrieves the model descriptions satisfying the criteria specified in a provided query:

Models getModels(DeployedModelQuery query);

The method returns a list of DeployedModelDescription objects (type Models). Parameter query defines the deployed model query of type DeployedModelQuery. You need to have the permission to read model data to perform this method.