org.cyclos.impl.users

Interface RecordFieldHandler

public interface RecordFieldHandler

Handler interface for record field permissions

Author:

jcomas

Method Summary

Modifier and Type	Method and Description
void	assignAllPermissionsToRecordField(RecordType recordType, RecordCustomField recordField, AdminProduct adminProduct) Assigns all the user records permissions (view, edit, create and remove) to the admin product, for the given record field
java.util.List<RecordCustomField>	getFieldsByAction(UserRecordType recordType, BasicUser user, RecordFieldAction action, boolean brokeringAction) Returns the enabled fields of the record type for the given user (and visible to the logged user) and the actions that the logged user can perform over them.
java.util.List<ProductRecordFieldDTO>	getProductRecordFields(Product product, java.lang.Class<? extends ProductRecordType> relationship) Returns the list of dtos for the given product and relationship determined by the relationship parameter
java.util.List<ProductRecordFieldDTO>	getProductRecordFields(org.cyclos.impl.users.ProductsAccessor accessor, java.lang.Class<? extends ProductRecordType> relationship) Returns the list of dtos for the given product accessor and relationship determined by the relationship parameter
org.cyclos.impl.utils.BooleanPropertiesHolder<RecordCustomField>	getProductRecordFieldsPropertiesHolder(RecordType recordType, java.util.Collection<? extends Product> products, java.lang.Class<? extends ProductRecordType> relationship) Builds and returns a boolean properties holder for the given record type, list of products and relationship determined by the relationship parameter.
java.util.List<RecordCustomField>	getSystemFieldsByAction(SystemRecordType recordType, RecordFieldAction action) Returns the fields of the given record type that matches with the admin permissions according to the given action
<PRT extends ProductRecordType> void	toEntityProductRecordTypes(Product product, java.util.Collection<PRT> prdRecordTypes, java.util.Collection<? extends ProductRecordFieldDTO> dtos, java.lang.Class<PRT> relationship) Performs the conversion from the dtos to the prdRecordTypes collection of the relationship determined by the relationship parameter.

Method Detail

assignAllPermissionsToRecordField

void assignAllPermissionsToRecordField(RecordType recordType,
                                       RecordCustomField recordField,
                                       AdminProduct adminProduct)

Assigns all the user records permissions (view, edit, create and remove) to the admin product, for the given record field

getFieldsByAction

java.util.List<RecordCustomField> getFieldsByAction(UserRecordType recordType,
                                                    BasicUser user,
                                                    RecordFieldAction action,
                                                    boolean brokeringAction)

Returns the enabled fields of the record type for the given user (and visible to the logged user) and the actions that the logged user can perform over them.

Parameters:

brokeringAction - This flag indicates if the method is called in a brokering context, null if we don't really know if it's for brokering or not.

getProductRecordFields

java.util.List<ProductRecordFieldDTO> getProductRecordFields(Product product,
                                                             java.lang.Class<? extends ProductRecordType> relationship)

Returns the list of dtos for the given product and relationship determined by the relationship parameter

getProductRecordFields

java.util.List<ProductRecordFieldDTO> getProductRecordFields(org.cyclos.impl.users.ProductsAccessor accessor,
                                                             java.lang.Class<? extends ProductRecordType> relationship)

Returns the list of dtos for the given product accessor and relationship determined by the relationship parameter

getProductRecordFieldsPropertiesHolder

org.cyclos.impl.utils.BooleanPropertiesHolder<RecordCustomField> getProductRecordFieldsPropertiesHolder(RecordType recordType,
                                                                                                        java.util.Collection<? extends Product> products,
                                                                                                        java.lang.Class<? extends ProductRecordType> relationship)

Builds and returns a boolean properties holder for the given record type, list of products and relationship determined by the relationship parameter.

getSystemFieldsByAction

java.util.List<RecordCustomField> getSystemFieldsByAction(SystemRecordType recordType,
                                                          RecordFieldAction action)

Returns the fields of the given record type that matches with the admin permissions according to the given action

toEntityProductRecordTypes

<PRT extends ProductRecordType> void toEntityProductRecordTypes(Product product,
                                                                java.util.Collection<PRT> prdRecordTypes,
                                                                java.util.Collection<? extends ProductRecordFieldDTO> dtos,
                                                                java.lang.Class<PRT> relationship)

Performs the conversion from the dtos to the prdRecordTypes collection of the relationship determined by the relationship parameter.