ModelsService (marklogic-data-hub 5.4.2 API)

```
public interface ModelsService
```
Provides a set of operations on the database server

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`createModel(com.fasterxml.jackson.databind.JsonNode input)` Create a new model, resulting in a new entity descriptor with a primary entity type in it.
`void`	`deleteModel(java.lang.String entityName)` Delete an entity model
`com.fasterxml.jackson.databind.JsonNode`	`generateModelConfig()` Invokes the generateModelConfig operation on the database server
`com.fasterxml.jackson.databind.JsonNode`	`generateProtectedPathConfig(com.fasterxml.jackson.databind.JsonNode models)` Generate a CMA config object with protected paths and query rolesets based on the 'pii' arrays in the given entity models
`com.fasterxml.jackson.databind.JsonNode`	`getLatestJobData(java.lang.String entityCollection)` Invokes the getLatestJobData operation on the database server
`com.fasterxml.jackson.databind.JsonNode`	`getModelReferences(java.lang.String entityName)` Returns a json containing the names of the models and steps that reference the given entity model.
`com.fasterxml.jackson.databind.JsonNode`	`getPrimaryEntityTypes()` Returns an array of primary entity types.
`static ModelsService`	`on(com.marklogic.client.DatabaseClient db)` Creates a ModelsService object for executing operations on the database server.
`static ModelsService`	`on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration)` Creates a ModelsService object for executing operations on the database server.
`void`	`saveModel(com.fasterxml.jackson.databind.JsonNode model)` Save a model, where the input is a JSON model
`void`	`saveModels(com.fasterxml.jackson.databind.JsonNode models)` Save an array of entity models to only the database associated with the app server that receives this request
`void`	`updateModelEntityTypes(com.fasterxml.jackson.databind.JsonNode input)` Invokes the updateModelEntityTypes operation on the database server
`com.fasterxml.jackson.databind.JsonNode`	`updateModelInfo(java.lang.String name, java.lang.String description)` Update the description of an existing model.

- Method Detail
  - on
```
static ModelsService on(com.marklogic.client.DatabaseClient db)
```
    Creates a ModelsService object for executing operations on the database server. The DatabaseClientFactory class can create the DatabaseClient parameter. A single client object can be used for any number of requests and in multiple threads.
    
    Parameters:
    
    db - provides a client for communicating with the database server
    
    Returns:
    
    an object for executing database operations
  - on
```
static ModelsService on(com.marklogic.client.DatabaseClient db,
                        com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration)
```
    Creates a ModelsService object for executing operations on the database server. The DatabaseClientFactory class can create the DatabaseClient parameter. A single client object can be used for any number of requests and in multiple threads. The service declaration uses a custom implementation of the same service instead of the default implementation of the service by specifying an endpoint directory in the modules database with the implementation. A service.json file with the declaration can be read with FileHandle or a string serialization of the JSON declaration with StringHandle.
    
    Parameters:
    
    db - provides a client for communicating with the database server
    
    serviceDeclaration - substitutes a custom implementation of the service
    
    Returns:
    
    an object for executing database operations
  - updateModelInfo
```
com.fasterxml.jackson.databind.JsonNode updateModelInfo(java.lang.String name,
                                                        java.lang.String description)
```
    Update the description of an existing model. Model title and version cannot yet be edited because doing so would break existing mapping and mastering configurations.
    
    Parameters:
    
    name - The name of the model
    
    description - provides input
    
    Returns:
    
    as output
  - saveModel
```
void saveModel(com.fasterxml.jackson.databind.JsonNode model)
```
    Save a model, where the input is a JSON model
    
    Parameters:
    
    model - provides input
  - generateProtectedPathConfig
```
com.fasterxml.jackson.databind.JsonNode generateProtectedPathConfig(com.fasterxml.jackson.databind.JsonNode models)
```
    Generate a CMA config object with protected paths and query rolesets based on the 'pii' arrays in the given entity models
    
    Parameters:
    
    models - Array of entity models
    
    Returns:
    
    as output
  - generateModelConfig
```
com.fasterxml.jackson.databind.JsonNode generateModelConfig()
```
    Invokes the generateModelConfig operation on the database server
    
    Returns:
    
    as output
  - getPrimaryEntityTypes
```
com.fasterxml.jackson.databind.JsonNode getPrimaryEntityTypes()
```
    Returns an array of primary entity types. A primary entity type is the entity type in a model descriptor with a name equal to the title of the model descriptor.
    
    Returns:
    
    as output
  - deleteModel
```
void deleteModel(java.lang.String entityName)
```
    Delete an entity model
    
    Parameters:
    
    entityName - The name of the primary entity in the model
  - createModel
```
com.fasterxml.jackson.databind.JsonNode createModel(com.fasterxml.jackson.databind.JsonNode input)
```
    Create a new model, resulting in a new entity descriptor with a primary entity type in it.
    
    Parameters:
    
    input - provides input
    
    Returns:
    
    as output
  - saveModels
```
void saveModels(com.fasterxml.jackson.databind.JsonNode models)
```
    Save an array of entity models to only the database associated with the app server that receives this request
    
    Parameters:
    
    models - The array of entity models
  - getModelReferences
```
com.fasterxml.jackson.databind.JsonNode getModelReferences(java.lang.String entityName)
```
    Returns a json containing the names of the models and steps that reference the given entity model.
    
    Parameters:
    
    entityName - The name of the primary entity in the model
    
    Returns:
    
    as output
  - updateModelEntityTypes
```
void updateModelEntityTypes(com.fasterxml.jackson.databind.JsonNode input)
```
    Invokes the updateModelEntityTypes operation on the database server
    
    Parameters:
    
    input - provides input
  - getLatestJobData
```
com.fasterxml.jackson.databind.JsonNode getLatestJobData(java.lang.String entityCollection)
```
    Invokes the getLatestJobData operation on the database server
    
    Parameters:
    
    entityCollection - provides input
    
    Returns:
    
    as output

Interface ModelsService

Method Summary

Method Detail

on

on

updateModelInfo

saveModel

generateProtectedPathConfig

generateModelConfig

getPrimaryEntityTypes

deleteModel

createModel

saveModels

getModelReferences

updateModelEntityTypes

getLatestJobData