com.laserfiche.repository.api.clients

Interface TemplateDefinitionsClient

All Known Implementing Classes:

TemplateDefinitionsClientImpl

public interface TemplateDefinitionsClient

The Laserfiche Repository TemplateDefinitions API client.

Method Summary

Modifier and Type	Method and Description
WTemplateInfo	getTemplateDefinitionById(ParametersForGetTemplateDefinitionById parameters) - 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.
ODataValueContextOfIListOfWTemplateInfo	getTemplateDefinitions(ParametersForGetTemplateDefinitions parameters) - Returns all template definitions (including field definitions) in the repository.
void	getTemplateDefinitionsForEach(Function<ODataValueContextOfIListOfWTemplateInfo,Boolean> callback, Integer maxPageSize, ParametersForGetTemplateDefinitions parameters) Provides the functionality to iteratively (i.e.
ODataValueContextOfIListOfWTemplateInfo	getTemplateDefinitionsNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.
ODataValueContextOfIListOfTemplateFieldInfo	getTemplateFieldDefinitions(ParametersForGetTemplateFieldDefinitions parameters) - Returns the field definitions assigned to a template definition. - Provide a template definition ID, and get a paged listing of the field definitions assigned to that template.
ODataValueContextOfIListOfTemplateFieldInfo	getTemplateFieldDefinitionsByTemplateName(ParametersForGetTemplateFieldDefinitionsByTemplateName parameters) - Returns the field definitions assigned to a template definition. - Provide a template definition name, and get a paged listing of the field definitions assigned to that template.
void	getTemplateFieldDefinitionsByTemplateNameForEach(Function<ODataValueContextOfIListOfTemplateFieldInfo,Boolean> callback, Integer maxPageSize, ParametersForGetTemplateFieldDefinitionsByTemplateName parameters) Provides the functionality to iteratively (i.e.
ODataValueContextOfIListOfTemplateFieldInfo	getTemplateFieldDefinitionsByTemplateNameNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.
void	getTemplateFieldDefinitionsForEach(Function<ODataValueContextOfIListOfTemplateFieldInfo,Boolean> callback, Integer maxPageSize, ParametersForGetTemplateFieldDefinitions parameters) Provides the functionality to iteratively (i.e.
ODataValueContextOfIListOfTemplateFieldInfo	getTemplateFieldDefinitionsNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.

Method Detail

getTemplateDefinitions

ODataValueContextOfIListOfWTemplateInfo getTemplateDefinitions(ParametersForGetTemplateDefinitions parameters)

- 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:

parameters - An object of type ParametersForGetTemplateDefinitions which encapsulates the parameters of getTemplateDefinitions method.

Returns:

ODataValueContextOfIListOfWTemplateInfo The return value

getTemplateDefinitionsNextLink

ODataValueContextOfIListOfWTemplateInfo getTemplateDefinitionsNextLink(String nextLink,
                                                                       int 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:

ODataValueContextOfIListOfWTemplateInfo The return value

getTemplateDefinitionsForEach

void getTemplateDefinitionsForEach(Function<ODataValueContextOfIListOfWTemplateInfo,Boolean> callback,
                                   Integer maxPageSize,
                                   ParametersForGetTemplateDefinitions parameters)

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.

parameters - An object of type ParametersForGetTemplateDefinitions which encapsulates the parameters of getTemplateDefinitions method.

getTemplateFieldDefinitionsByTemplateName

ODataValueContextOfIListOfTemplateFieldInfo getTemplateFieldDefinitionsByTemplateName(ParametersForGetTemplateFieldDefinitionsByTemplateName parameters)

- Returns the field definitions assigned to a template definition.
- Provide a template definition name, and get a paged listing of the field definitions assigned to that template.
- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.

Parameters:

parameters - An object of type ParametersForGetTemplateFieldDefinitionsByTemplateName which encapsulates the parameters of getTemplateFieldDefinitionsByTemplateName method.

Returns:

ODataValueContextOfIListOfTemplateFieldInfo The return value

getTemplateFieldDefinitionsByTemplateNameNextLink

ODataValueContextOfIListOfTemplateFieldInfo getTemplateFieldDefinitionsByTemplateNameNextLink(String nextLink,
                                                                                              int 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:

ODataValueContextOfIListOfTemplateFieldInfo The return value

getTemplateFieldDefinitionsByTemplateNameForEach

void getTemplateFieldDefinitionsByTemplateNameForEach(Function<ODataValueContextOfIListOfTemplateFieldInfo,Boolean> callback,
                                                      Integer maxPageSize,
                                                      ParametersForGetTemplateFieldDefinitionsByTemplateName parameters)

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.

parameters - An object of type ParametersForGetTemplateFieldDefinitionsByTemplateName which encapsulates the parameters of getTemplateFieldDefinitionsByTemplateName method.

getTemplateFieldDefinitions

ODataValueContextOfIListOfTemplateFieldInfo getTemplateFieldDefinitions(ParametersForGetTemplateFieldDefinitions parameters)

- Returns the field definitions assigned to a template definition.
- Provide a template definition ID, and get a paged listing of the field definitions assigned to that template.
- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.

Parameters:

parameters - An object of type ParametersForGetTemplateFieldDefinitions which encapsulates the parameters of getTemplateFieldDefinitions method.

Returns:

ODataValueContextOfIListOfTemplateFieldInfo The return value

getTemplateFieldDefinitionsNextLink

ODataValueContextOfIListOfTemplateFieldInfo getTemplateFieldDefinitionsNextLink(String nextLink,
                                                                                int 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:

ODataValueContextOfIListOfTemplateFieldInfo The return value

getTemplateFieldDefinitionsForEach

void getTemplateFieldDefinitionsForEach(Function<ODataValueContextOfIListOfTemplateFieldInfo,Boolean> callback,
                                        Integer maxPageSize,
                                        ParametersForGetTemplateFieldDefinitions parameters)

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.

parameters - An object of type ParametersForGetTemplateFieldDefinitions which encapsulates the parameters of getTemplateFieldDefinitions method.

getTemplateDefinitionById

WTemplateInfo getTemplateDefinitionById(ParametersForGetTemplateDefinitionById parameters)

- 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:

parameters - An object of type ParametersForGetTemplateDefinitionById which encapsulates the parameters of getTemplateDefinitionById method.

Returns:

WTemplateInfo The return value