UserCustomFieldServiceLocal (Cyclos 4.14.14 Scripting API Documentation)

All Superinterfaces:

BaseCustomFieldService<UserCustomFieldDTO,UserCustomFieldData,Void>, CRUDService<UserCustomFieldDTO,UserCustomFieldData,Void>, CRUDServiceLocal<UserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>, Service, UserCustomFieldService

All Known Implementing Classes:

UserCustomFieldServiceImpl
```
public interface UserCustomFieldServiceLocal
extends UserCustomFieldService, CRUDServiceLocal<UserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>
```
Local interface for user custom field service

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`existsUser(UserCustomField field, String value)`	Returns true if there exists a non removed user that has a custom field value with the given value.
`List<UserCustomField>`	`listAll()`	Returns all user custom fields
`List<String>`	`listOidcClaims()`	Returns all OpenID Connect claims from user custom fields for this network
`void`	`purgeValues(BasicUser user)`	Purges the custom field values of the given user that are set to be purged with the user

Methods inherited from interface org.cyclos.services.system.BaseCustomFieldService
saveOrder

Methods inherited from interface org.cyclos.services.CRUDService
getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal
find, findAll, getEntityClass, newEntity, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Methods inherited from interface org.cyclos.services.users.UserCustomFieldService
list

- Method Detail
  - existsUser
```
boolean existsUser(UserCustomField field,
                   String value)
```
    Returns true if there exists a non removed user that has a custom field value with the given value. Only two types of field are supported: string and integer. Based on the type of the field, it looks on the corresponding attribute of the custom field value.
  - listAll
```
List<UserCustomField> listAll()
```
    Returns all user custom fields
  - listOidcClaims
```
List<String> listOidcClaims()
```
    Returns all OpenID Connect claims from user custom fields for this network
  - purgeValues
```
void purgeValues(BasicUser user)
```
    Purges the custom field values of the given user that are set to be purged with the user