org.cyclos.impl.users

Interface UserCustomFieldServiceLocal

All Superinterfaces:

BaseCustomFieldService<UserCustomFieldDTO,UserCustomFieldData,java.lang.Void>, CRUDService<UserCustomFieldDTO,UserCustomFieldData,java.lang.Void>, org.cyclos.impl.CRUDServiceLocal<UserCustomField,UserCustomFieldDTO,UserCustomFieldData,java.lang.Void>, Service, UserCustomFieldService

public interface UserCustomFieldServiceLocal
extends UserCustomFieldService, org.cyclos.impl.CRUDServiceLocal<UserCustomField,UserCustomFieldDTO,UserCustomFieldData,java.lang.Void>

Local interface for user custom field service

Author:

luis

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<UserCustomField>	getEditableUserCustomFields(User user) Returns the given user's custom fields that can be updated by the logged user This method should be invoked when: - Internal or public registration: user should be transient - The logged user is editing other user's profile.
java.util.List<UserCustomField>	getEnabledUserCustomFields(Group group) Returns the enabled custom fields for the group
java.util.List<UserCustomField>	getEnabledUserCustomFields(User user) Returns the enabled custom fields for the user
org.cyclos.impl.users.UserCustomFieldServiceImpl.FieldsContext	getFieldsContext(User user) Returns the context (or functionality) where the fields are being displayed
java.util.List<UserCustomField>	getManagePrivacyCustomFields(User user) Returns the given user's custom fields that are allowed to be modified it's privacy by the current user
java.util.List<UserCustomField>	getSearchFilters(org.cyclos.impl.users.UserCustomFieldSearchContext context, boolean searchOverBrokeredUsers) Returns the user custom fields that can be used as filters in a search, according to the given context
java.util.List<UserCustomField>	getVisibleUserCustomFields(User user) Returns the given user's custom fields that are visible to the current user This method should be used to get the visible user custom fields when: - Internal or public registration: user should be transient - The logged user is viewing other user's profile.
java.util.List<UserCustomFieldValue>	getVisibleUserCustomValues(User user) Returns the user custom values visible to the logged user.
java.util.List<UserCustomField>	listAll() Returns all user custom fields
java.util.Set<CustomFieldValueForSearchDTO>	retainAllowedFilters(java.util.Set<CustomFieldValueForSearchDTO> customValues, org.cyclos.impl.users.UserCustomFieldSearchContext context, boolean searchOverBrokeredUsers) Returns the filtered custom values, according to the given context

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

list

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, toDTO, toEntity, validate

Method Detail

getEditableUserCustomFields

java.util.List<UserCustomField> getEditableUserCustomFields(User user)

Returns the given user's custom fields that can be updated by the logged user This method should be invoked when: - Internal or public registration: user should be transient - The logged user is editing other user's profile. - The logged user is editing his own profile, in which case the parameter should be the logged user.

getEnabledUserCustomFields

java.util.List<UserCustomField> getEnabledUserCustomFields(Group group)

Returns the enabled custom fields for the group

getEnabledUserCustomFields

java.util.List<UserCustomField> getEnabledUserCustomFields(User user)

Returns the enabled custom fields for the user

getFieldsContext

org.cyclos.impl.users.UserCustomFieldServiceImpl.FieldsContext getFieldsContext(User user)

Returns the context (or functionality) where the fields are being displayed

getManagePrivacyCustomFields

java.util.List<UserCustomField> getManagePrivacyCustomFields(User user)

Returns the given user's custom fields that are allowed to be modified it's privacy by the current user

getSearchFilters

java.util.List<UserCustomField> getSearchFilters(org.cyclos.impl.users.UserCustomFieldSearchContext context,
                                               boolean searchOverBrokeredUsers)

Returns the user custom fields that can be used as filters in a search, according to the given context

getVisibleUserCustomFields

java.util.List<UserCustomField> getVisibleUserCustomFields(User user)

Returns the given user's custom fields that are visible to the current user This method should be used to get the visible user custom fields when: - Internal or public registration: user should be transient - The logged user is viewing other user's profile. - The logged user is viewing his own profile, in which case the parameter should be the logged user.

getVisibleUserCustomValues

java.util.List<UserCustomFieldValue> getVisibleUserCustomValues(User user)

Returns the user custom values visible to the logged user.

listAll

java.util.List<UserCustomField> listAll()

Returns all user custom fields

retainAllowedFilters

java.util.Set<CustomFieldValueForSearchDTO> retainAllowedFilters(java.util.Set<CustomFieldValueForSearchDTO> customValues,
                                                               org.cyclos.impl.users.UserCustomFieldSearchContext context,
                                                               boolean searchOverBrokeredUsers)

Returns the filtered custom values, according to the given context

Parameters:

customValues - The list of custom values

context - The context where custom fields are being used for search

searchOverBrokeredUsers -