com.laserfiche.repository.api.clients.impl

Class TemplateDefinitionsClientImpl

java.lang.Object

com.laserfiche.repository.api.clients.impl.ApiClient

com.laserfiche.repository.api.clients.impl.TemplateDefinitionsClientImpl

All Implemented Interfaces:

TemplateDefinitionsClient

public class TemplateDefinitionsClientImpl
extends ApiClient
implements TemplateDefinitionsClient

The Laserfiche Repository TemplateDefinitions API client.

Field Summary

Fields inherited from class com.laserfiche.repository.api.clients.impl.ApiClient

baseUrl, httpClient, httpRequestHandler, objectMapper

Constructor Summary

Constructors

Constructor and Description
TemplateDefinitionsClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient, com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)

Method Summary

Modifier and Type	Method and Description
TemplateDefinition	getTemplateDefinition(ParametersForGetTemplateDefinition 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.
TemplateDefinitionCollectionResponse	listTemplateDefinitions(ParametersForListTemplateDefinitions parameters) - Returns all template definitions (including field definitions) in the repository.
void	listTemplateDefinitionsForEach(Function<TemplateDefinitionCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListTemplateDefinitions parameters) Provides the functionality to iteratively (i.e.
TemplateDefinitionCollectionResponse	listTemplateDefinitionsNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.
TemplateFieldDefinitionCollectionResponse	listTemplateFieldDefinitionsByTemplateId(ParametersForListTemplateFieldDefinitionsByTemplateId 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.
void	listTemplateFieldDefinitionsByTemplateIdForEach(Function<TemplateFieldDefinitionCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListTemplateFieldDefinitionsByTemplateId parameters) Provides the functionality to iteratively (i.e.
TemplateFieldDefinitionCollectionResponse	listTemplateFieldDefinitionsByTemplateIdNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.
TemplateFieldDefinitionCollectionResponse	listTemplateFieldDefinitionsByTemplateName(ParametersForListTemplateFieldDefinitionsByTemplateName 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	listTemplateFieldDefinitionsByTemplateNameForEach(Function<TemplateFieldDefinitionCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListTemplateFieldDefinitionsByTemplateName parameters) Provides the functionality to iteratively (i.e.
TemplateFieldDefinitionCollectionResponse	listTemplateFieldDefinitionsByTemplateNameNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.

Methods inherited from class com.laserfiche.repository.api.clients.impl.ApiClient

toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TemplateDefinitionsClientImpl

public TemplateDefinitionsClientImpl(String baseUrl,
                                     kong.unirest.UnirestInstance httpClient,
                                     com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)

Method Detail

listTemplateDefinitions

public TemplateDefinitionCollectionResponse listTemplateDefinitions(ParametersForListTemplateDefinitions parameters)

Description copied from interface: TemplateDefinitionsClient

- 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.
- Required OAuth scope: repository.Read

Specified by:

listTemplateDefinitions in interface TemplateDefinitionsClient

Parameters:

parameters - An object of type ParametersForListTemplateDefinitions which encapsulates the parameters of listTemplateDefinitions method.

Returns:

TemplateDefinitionCollectionResponse The return value

listTemplateDefinitionsNextLink

public TemplateDefinitionCollectionResponse listTemplateDefinitionsNextLink(String nextLink,
                                                                            int maxPageSize)

Description copied from interface: TemplateDefinitionsClient

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

Specified by:

listTemplateDefinitionsNextLink in interface TemplateDefinitionsClient

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:

TemplateDefinitionCollectionResponse The return value

listTemplateDefinitionsForEach

public void listTemplateDefinitionsForEach(Function<TemplateDefinitionCollectionResponse,Boolean> callback,
                                           Integer maxPageSize,
                                           ParametersForListTemplateDefinitions parameters)

Description copied from interface: TemplateDefinitionsClient

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

Specified by:

listTemplateDefinitionsForEach in interface TemplateDefinitionsClient

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 ParametersForListTemplateDefinitions which encapsulates the parameters of listTemplateDefinitions method.

listTemplateFieldDefinitionsByTemplateName

public TemplateFieldDefinitionCollectionResponse listTemplateFieldDefinitionsByTemplateName(ParametersForListTemplateFieldDefinitionsByTemplateName parameters)

Description copied from interface: TemplateDefinitionsClient

- 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.
- Required OAuth scope: repository.Read

Specified by:

listTemplateFieldDefinitionsByTemplateName in interface TemplateDefinitionsClient

Parameters:

parameters - An object of type ParametersForListTemplateFieldDefinitionsByTemplateName which encapsulates the parameters of listTemplateFieldDefinitionsByTemplateName method.

Returns:

TemplateFieldDefinitionCollectionResponse The return value

listTemplateFieldDefinitionsByTemplateNameNextLink

public TemplateFieldDefinitionCollectionResponse listTemplateFieldDefinitionsByTemplateNameNextLink(String nextLink,
                                                                                                    int maxPageSize)

Description copied from interface: TemplateDefinitionsClient

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

Specified by:

listTemplateFieldDefinitionsByTemplateNameNextLink in interface TemplateDefinitionsClient

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:

TemplateFieldDefinitionCollectionResponse The return value

listTemplateFieldDefinitionsByTemplateNameForEach

public void listTemplateFieldDefinitionsByTemplateNameForEach(Function<TemplateFieldDefinitionCollectionResponse,Boolean> callback,
                                                              Integer maxPageSize,
                                                              ParametersForListTemplateFieldDefinitionsByTemplateName parameters)

Description copied from interface: TemplateDefinitionsClient

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

Specified by:

listTemplateFieldDefinitionsByTemplateNameForEach in interface TemplateDefinitionsClient

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 ParametersForListTemplateFieldDefinitionsByTemplateName which encapsulates the parameters of listTemplateFieldDefinitionsByTemplateName method.

getTemplateDefinition

public TemplateDefinition getTemplateDefinition(ParametersForGetTemplateDefinition parameters)

Description copied from interface: TemplateDefinitionsClient

- 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
- Required OAuth scope: repository.Read

Specified by:

getTemplateDefinition in interface TemplateDefinitionsClient

Parameters:

parameters - An object of type ParametersForGetTemplateDefinition which encapsulates the parameters of getTemplateDefinition method.

Returns:

TemplateDefinition The return value

listTemplateFieldDefinitionsByTemplateId

public TemplateFieldDefinitionCollectionResponse listTemplateFieldDefinitionsByTemplateId(ParametersForListTemplateFieldDefinitionsByTemplateId parameters)

Description copied from interface: TemplateDefinitionsClient

- 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.
- Required OAuth scope: repository.Read

Specified by:

listTemplateFieldDefinitionsByTemplateId in interface TemplateDefinitionsClient

Parameters:

parameters - An object of type ParametersForListTemplateFieldDefinitionsByTemplateId which encapsulates the parameters of listTemplateFieldDefinitionsByTemplateId method.

Returns:

TemplateFieldDefinitionCollectionResponse The return value

listTemplateFieldDefinitionsByTemplateIdNextLink

public TemplateFieldDefinitionCollectionResponse listTemplateFieldDefinitionsByTemplateIdNextLink(String nextLink,
                                                                                                  int maxPageSize)

Description copied from interface: TemplateDefinitionsClient

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

Specified by:

listTemplateFieldDefinitionsByTemplateIdNextLink in interface TemplateDefinitionsClient

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:

TemplateFieldDefinitionCollectionResponse The return value

listTemplateFieldDefinitionsByTemplateIdForEach

public void listTemplateFieldDefinitionsByTemplateIdForEach(Function<TemplateFieldDefinitionCollectionResponse,Boolean> callback,
                                                            Integer maxPageSize,
                                                            ParametersForListTemplateFieldDefinitionsByTemplateId parameters)

Description copied from interface: TemplateDefinitionsClient

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

Specified by:

listTemplateFieldDefinitionsByTemplateIdForEach in interface TemplateDefinitionsClient

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 ParametersForListTemplateFieldDefinitionsByTemplateId which encapsulates the parameters of listTemplateFieldDefinitionsByTemplateId method.