com.licensespring.management

Class ProductCustomFieldsService

java.lang.Object

com.licensespring.management.ProductCustomFieldsService

public class ProductCustomFieldsService
extends Object

CustomFieldsService class is used for searching, getting, creating, updating and deleting product custom fields.

Method Summary

Modifier and Type	Method and Description
BackOfficeProductCustomField	create(CreateProductCustomFieldRequest request) Creates a new product custom field.
void	delete(Integer id) Deletes the product custom field.
BackOfficeProductCustomField	get(Integer id) Retrieves product custom field data.
List<BackOfficeProductCustomField>	paginate(SearchProductCustomFieldsRequest request) Goes through all pages of the search product custom fields response and returns a list with all possible product custom fields that satisfy the request.
SearchResult<BackOfficeProductCustomField>	search(SearchProductCustomFieldsRequest request) Searches through all product custom fields and returns the search result which contains all product custom fields that satisfy the request queries.
BackOfficeProductCustomField	update(Integer id, UpdateProductCustomFieldRequest request) Updates the product custom field.

Methods inherited from class java.lang.Object

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

Method Detail

search

public SearchResult<BackOfficeProductCustomField> search(SearchProductCustomFieldsRequest request)
                                                  throws com.licensespring.model.exceptions.LicenseSpringException

Searches through all product custom fields and returns the search result which contains all product custom fields that satisfy the request queries.

Parameters:

request - search request, can be made using the builder method

Returns:

paginated result that contains list of product custom fields

Throws:

com.licensespring.model.exceptions.LicenseSpringException

get

public BackOfficeProductCustomField get(Integer id)
                                 throws com.licensespring.model.exceptions.LicenseSpringException

Retrieves product custom field data.

Parameters:

id - id of the product custom field that needs to be fetched

Returns:

the BackOfficeProductCustomField object that contains detailed information about the custom field

Throws:

com.licensespring.model.exceptions.LicenseSpringException

create

public BackOfficeProductCustomField create(CreateProductCustomFieldRequest request)
                                    throws com.licensespring.model.exceptions.LicenseSpringException

Creates a new product custom field.

Parameters:

request - use builder for constructing

Returns:

the BackOfficeProductCustomField object that contains detailed information about the custom field

Throws:

com.licensespring.model.exceptions.LicenseSpringException

update

public BackOfficeProductCustomField update(Integer id,
                                           UpdateProductCustomFieldRequest request)
                                    throws com.licensespring.model.exceptions.LicenseSpringException

Updates the product custom field.

Parameters:

id - id of the product custom field that needs an update

request - use builder for constructing, fill only fields that you want to update

Returns:

the BackOfficeProductCustomField object that contains detailed information about the updated custom field

Throws:

com.licensespring.model.exceptions.LicenseSpringException

delete

public void delete(Integer id)
            throws com.licensespring.model.exceptions.LicenseSpringException

Deletes the product custom field.

Parameters:

id - id of the product custom field that needs to be deleted.

Throws:

com.licensespring.model.exceptions.LicenseSpringException

paginate

public List<BackOfficeProductCustomField> paginate(SearchProductCustomFieldsRequest request)
                                            throws com.licensespring.model.exceptions.LicenseSpringException

Goes through all pages of the search product custom fields response and returns a list with all possible product custom fields that satisfy the request. Makes multiple requests to the server until all results have been found. Use search(SearchProductCustomFieldsRequest) in order to get results per page.

Parameters:

request - can be made with builder, contains query fields

Returns:

list of all product custom fields that satisfy the request

Throws:

com.licensespring.model.exceptions.LicenseSpringException