org.cyclos.impl.users

Interface ProductUserCustomFieldHandler

public interface ProductUserCustomFieldHandler

Handler interface for product user custom fields

Author:

jcomas

Method Summary

Methods

Modifier and Type	Method and Description
void	filterCustomFieldActionsEnabledForUser(User user, org.cyclos.impl.utils.BooleanPropertiesHolder<UserCustomField> userCustomFieldActions) Removes from the given Map all custom fields which are not enabled for the given user
java.util.List<UserCustomField>	filterEnabledCustomFields(org.cyclos.impl.utils.BooleanPropertiesHolder<UserCustomField> productMyCustomFields) Returns the list of custom fields that are enabled in the given Map
java.util.List<UserCustomField>	filterMyCustomFields(org.cyclos.impl.utils.BooleanPropertiesHolder<UserCustomField> productMyCustomFields, java.lang.Boolean editableAtRegistration, java.lang.Boolean visible, java.lang.Boolean editable, java.lang.Boolean managePrivacy) Returns a list of the enabled user custom fields that satisfies at least one of the conditions defined in the remaining arguments.
java.util.List<UserCustomField>	filterUserCustomFields(org.cyclos.impl.utils.BooleanPropertiesHolder<UserCustomField> productUserCustomFields, java.lang.Boolean visible, java.lang.Boolean editable, java.lang.Boolean inUserSearch, java.lang.Boolean inAdSearch, java.lang.Boolean inRecordSearch) Returns a list of the visible user custom fields that satisfies at least one of the conditions defined in the remaining arguments.
java.util.List<UserCustomFieldActions>	getUserEnabledCustomFieldsAndActions(User user) Returns the enabled fields for the given user (and visible to the logged user) and the actions that the logged user can make over the custom fields.

Method Detail

filterCustomFieldActionsEnabledForUser

void filterCustomFieldActionsEnabledForUser(User user,
                                          org.cyclos.impl.utils.BooleanPropertiesHolder<UserCustomField> userCustomFieldActions)

Removes from the given Map all custom fields which are not enabled for the given user

filterEnabledCustomFields

java.util.List<UserCustomField> filterEnabledCustomFields(org.cyclos.impl.utils.BooleanPropertiesHolder<UserCustomField> productMyCustomFields)

Returns the list of custom fields that are enabled in the given Map

filterMyCustomFields

java.util.List<UserCustomField> filterMyCustomFields(org.cyclos.impl.utils.BooleanPropertiesHolder<UserCustomField> productMyCustomFields,
                                                   java.lang.Boolean editableAtRegistration,
                                                   java.lang.Boolean visible,
                                                   java.lang.Boolean editable,
                                                   java.lang.Boolean managePrivacy)

Returns a list of the enabled user custom fields that satisfies at least one of the conditions defined in the remaining arguments. If an argument is null, the condition is not taken into account.

filterUserCustomFields

java.util.List<UserCustomField> filterUserCustomFields(org.cyclos.impl.utils.BooleanPropertiesHolder<UserCustomField> productUserCustomFields,
                                                     java.lang.Boolean visible,
                                                     java.lang.Boolean editable,
                                                     java.lang.Boolean inUserSearch,
                                                     java.lang.Boolean inAdSearch,
                                                     java.lang.Boolean inRecordSearch)

Returns a list of the visible user custom fields that satisfies at least one of the conditions defined in the remaining arguments. If an argument is null, the condition is not taken into account.

getUserEnabledCustomFieldsAndActions

java.util.List<UserCustomFieldActions> getUserEnabledCustomFieldsAndActions(User user)

Returns the enabled fields for the given user (and visible to the logged user) and the actions that the logged user can make over the custom fields.