com.silanis.esl.sdk.service

Class CustomFieldService

java.lang.Object

com.silanis.esl.sdk.service.CustomFieldService

public class CustomFieldService
extends Object

The CustomFieldService class provides methods to create account custom fields and user custom fields.

Constructor Summary

Constructors

Constructor and Description
CustomFieldService(CustomFieldApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CustomField	createCustomField(CustomField customField) Create an account custom field.
void	deleteCustomField(String id) Delete an account custom field.
void	deleteCustomFieldValue(String id) Delete an user custom field.
boolean	doesCustomFieldExist(String id) Determine if a custom field already existed
boolean	doesCustomFieldValueExist(String id) Determine if an user custom field already existed
CustomField	getCustomField(String id) Get an account custom field.
List<CustomField>	getCustomFields(Direction direction) Get the entire list of account custom fields.
List<CustomField>	getCustomFields(Direction direction, PageRequest request) Get the list of account custom fields.
CustomFieldValue	getCustomFieldValue(String customFieldId) Get a custom field for the user.
List<CustomFieldValue>	getCustomFieldValues() Get all custom fields for the user.
CustomFieldValue	submitCustomFieldValue(CustomFieldValue customFieldValue) Create an user custom field.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFieldService

public CustomFieldService(CustomFieldApiClient apiClient)

Method Detail

createCustomField

public CustomField createCustomField(CustomField customField)

Create an account custom field. If the custom field already existed then update it.

Parameters:

customField -

Returns:

the custom field added created or updated

doesCustomFieldExist

public boolean doesCustomFieldExist(String id)

Determine if a custom field already existed

Parameters:

id - of custom field

Returns:

true if existed otherwise false

getCustomField

public CustomField getCustomField(String id)

Get an account custom field.

Parameters:

id - of custom field to get

Returns:

the custom field

getCustomFields

public List<CustomField> getCustomFields(Direction direction)

Get the entire list of account custom fields.

Parameters:

direction - of retrieved list to be sorted in ascending or descending order by id

Returns:

the list of custom fields

getCustomFields

public List<CustomField> getCustomFields(Direction direction,
                                         PageRequest request)

Get the list of account custom fields.

Parameters:

direction - of retrieved list to be sorted in ascending or descending order by id

request - identifying which page of results to return.

Returns:

the list of custom fields

deleteCustomField

public void deleteCustomField(String id)

Delete an account custom field.

Parameters:

id - of custom field to delete.

getCustomFieldValues

public List<CustomFieldValue> getCustomFieldValues()

Get all custom fields for the user.

Returns:

user custom field list

getCustomFieldValue

public CustomFieldValue getCustomFieldValue(String customFieldId)

Get a custom field for the user.

Parameters:

customFieldId - of user custom field

Returns:

user custom field

submitCustomFieldValue

public CustomFieldValue submitCustomFieldValue(CustomFieldValue customFieldValue)

Create an user custom field. If the custom field already existed then update it.

Parameters:

customFieldValue -

Returns:

user custom field id

deleteCustomFieldValue

public void deleteCustomFieldValue(String id)

Delete an user custom field.

Parameters:

id - of user custom field to delete.

doesCustomFieldValueExist

public boolean doesCustomFieldValueExist(String id)

Determine if an user custom field already existed

Parameters:

id - of user custom field

Returns:

true if existed otherwise false