com.licensespring.management

Class LicenseCustomFieldsService

java.lang.Object

com.licensespring.management.LicenseCustomFieldsService

public class LicenseCustomFieldsService
extends Object

LicenseCustomFieldsService class is used for searching, getting, creating, updating and deleting licenses custom fields.

Method Summary

Modifier and Type	Method and Description
BackOfficeLicenseCustomField	create(CreateLicenseCustomFieldRequest request) Creates a new license custom field.
void	delete(Integer id)
BackOfficeLicenseCustomField	get(Integer id) Retrieves license custom field data.
List<BackOfficeLicenseCustomField>	paginate(SearchLicenseCustomFieldsRequest request) Goes through all pages of the search license custom fields response and returns a list with all possible license custom fields that satisfy the request.
SearchResult<BackOfficeLicenseCustomField>	search(SearchLicenseCustomFieldsRequest request) Searches through all license custom fields and returns the search result which contains all license custom fields that satisfy the request queries.
BackOfficeLicenseCustomField	update(Integer id, UpdateCustomLicenseFieldRequest request) Updates the license 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<BackOfficeLicenseCustomField> search(SearchLicenseCustomFieldsRequest request)
                                                  throws com.licensespring.model.exceptions.LicenseSpringException

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

Parameters:

request - search request, can be made using builder method

Returns:

paginated result that contains list of license custom fields

Throws:

com.licensespring.model.exceptions.LicenseSpringException

get

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

Retrieves license custom field data.

Parameters:

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

Returns:

the BackOfficeLicenseCustom field object that contains detailed information about the custom license field

Throws:

com.licensespring.model.exceptions.LicenseSpringException

create

public BackOfficeLicenseCustomField create(CreateLicenseCustomFieldRequest request)
                                    throws com.licensespring.model.exceptions.LicenseSpringException

Creates a new license custom field.

Parameters:

request - use builder for constructing

Returns:

the BackOfficeLicenseCustom field object that contains detailed information about the custom license field

Throws:

com.licensespring.model.exceptions.LicenseSpringException

update

public BackOfficeLicenseCustomField update(Integer id,
                                           UpdateCustomLicenseFieldRequest request)
                                    throws com.licensespring.model.exceptions.LicenseSpringException

Updates the license custom field.

Parameters:

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

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

Returns:

the BackOfficeLicenseCustom field object that contains detailed information about the updated custom license field

Throws:

com.licensespring.model.exceptions.LicenseSpringException

delete

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

Throws:

com.licensespring.model.exceptions.LicenseSpringException

paginate

public List<BackOfficeLicenseCustomField> paginate(SearchLicenseCustomFieldsRequest request)
                                            throws com.licensespring.model.exceptions.LicenseSpringException

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

Parameters:

request - can be made with builder, contains query fields

Returns:

list of all license custom fields that satisfy the request

Throws:

com.licensespring.model.exceptions.LicenseSpringException