TemplateDefinitionsClient (Laserfiche Repository API Client 1.2.0 API)

All Known Implementing Classes:

TemplateDefinitionsClientImpl
```
public interface TemplateDefinitionsClient
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CompletableFuture<WTemplateInfo>`	`getTemplateDefinitionById(String repoId, Integer templateId, String culture, String select)` - Returns a single template definition (including field definitions, if relevant).
`CompletableFuture<ODataValueContextOfIListOfWTemplateInfo>`	`getTemplateDefinitions(String repoId, String templateName, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)` - Returns all template definitions (including field definitions) in the repository.
`CompletableFuture<Void>`	`getTemplateDefinitionsForEach(Function<CompletableFuture<ODataValueContextOfIListOfWTemplateInfo>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, String templateName, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)` Provides the functionality to iteratively (i.e.
`CompletableFuture<ODataValueContextOfIListOfWTemplateInfo>`	`getTemplateDefinitionsNextLink(String nextLink, Integer maxPageSize)` Returns the next subset of the requested collection, using a nextlink url.
`CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo>`	`getTemplateFieldDefinitions(String repoId, Integer templateId, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)` - Returns the field definitions assigned to a template definition.
`CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo>`	`getTemplateFieldDefinitionsByTemplateName(String repoId, String templateName, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)` - Returns the field definitions assigned to a template definition.
`CompletableFuture<Void>`	`getTemplateFieldDefinitionsByTemplateNameForEach(Function<CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, String templateName, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)` Provides the functionality to iteratively (i.e.
`CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo>`	`getTemplateFieldDefinitionsByTemplateNameNextLink(String nextLink, Integer maxPageSize)` Returns the next subset of the requested collection, using a nextlink url.
`CompletableFuture<Void>`	`getTemplateFieldDefinitionsForEach(Function<CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, Integer templateId, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)` Provides the functionality to iteratively (i.e.
`CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo>`	`getTemplateFieldDefinitionsNextLink(String nextLink, Integer maxPageSize)` Returns the next subset of the requested collection, using a nextlink url.

Method Detail

getTemplateDefinitions

CompletableFuture<ODataValueContextOfIListOfWTemplateInfo> getTemplateDefinitions(String repoId,
                                                                                  String templateName,
                                                                                  String prefer,
                                                                                  String culture,
                                                                                  String select,
                                                                                  String orderby,
                                                                                  Integer top,
                                                                                  Integer skip,
                                                                                  Boolean count)

- Returns all template definitions (including field definitions) in the repository. If a template name query parameter is given, then a single template definition is returned. - Provide a repository ID, and get a paged listing of template definitions available in the repository. Useful when trying to find a list of all template definitions available, rather than a specific one. - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.

Parameters:: repoId - The requested repository ID.; templateName - An optional query parameter. Can be used to get a single template definition using the template name.; prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.; culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.; select - Limits the properties returned in the result.; orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.; top - Limits the number of items returned from a collection.; skip - Excludes the specified number of items of the queried collection from the result.; count - Indicates whether the total count of items within a collection are returned in the result.
Returns:: CompletableFuture<ODataValueContextOfIListOfWTemplateInfo> The return value

getTemplateDefinitionsNextLink
```
CompletableFuture<ODataValueContextOfIListOfWTemplateInfo> getTemplateDefinitionsNextLink(String nextLink,
 Integer maxPageSize)
```
Returns the next subset of the requested collection, using a nextlink url.

Parameters:

nextLink - A url that allows retrieving the next subset of the requested collection.

maxPageSize - Optionally specify the maximum number of items to retrieve.

Returns:

CompletableFuture<ODataValueContextOfIListOfWTemplateInfo> The return value

getTemplateDefinitionsForEach

CompletableFuture<Void> getTemplateDefinitionsForEach(Function<CompletableFuture<ODataValueContextOfIListOfWTemplateInfo>,CompletableFuture<Boolean>> callback,
                                                      Integer maxPageSize,
                                                      String repoId,
                                                      String templateName,
                                                      String prefer,
                                                      String culture,
                                                      String select,
                                                      String orderby,
                                                      Integer top,
                                                      Integer skip,
                                                      Boolean count)

Provides the functionality to iteratively (i.e. through paging) call getTemplateDefinitions, and apply a function on the response of each iteration.

Parameters:: callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.; maxPageSize - Optionally specify the maximum number of items to retrieve.; repoId - The requested repository ID.; templateName - An optional query parameter. Can be used to get a single template definition using the template name.; prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.; culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.; select - Limits the properties returned in the result.; orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.; top - Limits the number of items returned from a collection.; skip - Excludes the specified number of items of the queried collection from the result.; count - Indicates whether the total count of items within a collection are returned in the result.
Returns:: CompletableFuture<Void> The return value

getTemplateFieldDefinitionsByTemplateName

CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo> getTemplateFieldDefinitionsByTemplateName(String repoId,
                                                                                                         String templateName,
                                                                                                         String prefer,
                                                                                                         String culture,
                                                                                                         String select,
                                                                                                         String orderby,
                                                                                                         Integer top,
                                                                                                         Integer skip,
                                                                                                         Boolean count)

Parameters:: repoId - The requested repository ID.; templateName - A required query parameter for the requested template name.; prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.; culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.; select - Limits the properties returned in the result.; orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.; top - Limits the number of items returned from a collection.; skip - Excludes the specified number of items of the queried collection from the result.; count - Indicates whether the total count of items within a collection are returned in the result.
Returns:: CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo> The return value

getTemplateFieldDefinitionsByTemplateNameNextLink

CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo> getTemplateFieldDefinitionsByTemplateNameNextLink(String nextLink,
                                                                                                                 Integer maxPageSize)

Returns the next subset of the requested collection, using a nextlink url.

Parameters:: nextLink - A url that allows retrieving the next subset of the requested collection.; maxPageSize - Optionally specify the maximum number of items to retrieve.
Returns:: CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo> The return value

getTemplateFieldDefinitionsByTemplateNameForEach

CompletableFuture<Void> getTemplateFieldDefinitionsByTemplateNameForEach(Function<CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo>,CompletableFuture<Boolean>> callback,
                                                                         Integer maxPageSize,
                                                                         String repoId,
                                                                         String templateName,
                                                                         String prefer,
                                                                         String culture,
                                                                         String select,
                                                                         String orderby,
                                                                         Integer top,
                                                                         Integer skip,
                                                                         Boolean count)

Provides the functionality to iteratively (i.e. through paging) call getTemplateFieldDefinitionsByTemplateName, and apply a function on the response of each iteration.

Parameters:: callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.; maxPageSize - Optionally specify the maximum number of items to retrieve.; repoId - The requested repository ID.; templateName - A required query parameter for the requested template name.; prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.; culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.; select - Limits the properties returned in the result.; orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.; top - Limits the number of items returned from a collection.; skip - Excludes the specified number of items of the queried collection from the result.; count - Indicates whether the total count of items within a collection are returned in the result.
Returns:: CompletableFuture<Void> The return value

getTemplateFieldDefinitions

CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo> getTemplateFieldDefinitions(String repoId,
                                                                                           Integer templateId,
                                                                                           String prefer,
                                                                                           String culture,
                                                                                           String select,
                                                                                           String orderby,
                                                                                           Integer top,
                                                                                           Integer skip,
                                                                                           Boolean count)

Parameters:: repoId - The requested repository ID.; templateId - The requested template definition ID.; prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.; culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.; select - Limits the properties returned in the result.; orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.; top - Limits the number of items returned from a collection.; skip - Excludes the specified number of items of the queried collection from the result.; count - Indicates whether the total count of items within a collection are returned in the result.
Returns:: CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo> The return value

getTemplateFieldDefinitionsNextLink
```
CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo> getTemplateFieldDefinitionsNextLink(String nextLink,
 Integer maxPageSize)
```
Returns the next subset of the requested collection, using a nextlink url.

Parameters:

nextLink - A url that allows retrieving the next subset of the requested collection.

maxPageSize - Optionally specify the maximum number of items to retrieve.

Returns:

CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo> The return value

getTemplateFieldDefinitionsForEach

CompletableFuture<Void> getTemplateFieldDefinitionsForEach(Function<CompletableFuture<ODataValueContextOfIListOfTemplateFieldInfo>,CompletableFuture<Boolean>> callback,
                                                           Integer maxPageSize,
                                                           String repoId,
                                                           Integer templateId,
                                                           String prefer,
                                                           String culture,
                                                           String select,
                                                           String orderby,
                                                           Integer top,
                                                           Integer skip,
                                                           Boolean count)

Provides the functionality to iteratively (i.e. through paging) call getTemplateFieldDefinitions, and apply a function on the response of each iteration.

Parameters:: callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.; maxPageSize - Optionally specify the maximum number of items to retrieve.; repoId - The requested repository ID.; templateId - The requested template definition ID.; prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.; culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.; select - Limits the properties returned in the result.; orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.; top - Limits the number of items returned from a collection.; skip - Excludes the specified number of items of the queried collection from the result.; count - Indicates whether the total count of items within a collection are returned in the result.
Returns:: CompletableFuture<Void> The return value

getTemplateDefinitionById
```
CompletableFuture<WTemplateInfo> getTemplateDefinitionById(String repoId,
 Integer templateId,
 String culture,
 String select)
```
- Returns a single template definition (including field definitions, if relevant). - Provide a template definition ID, and get the single template definition associated with that ID. Useful when a route provides a minimal amount of details, and more information about the specific template is needed. - Allowed OData query options: Select

Parameters:

repoId - The requested repository ID.

templateId - The requested template definition ID.

culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.

select - Limits the properties returned in the result.

Returns:

CompletableFuture<WTemplateInfo> The return value

Interface TemplateDefinitionsClient