org.cyclos.services.users

Interface RecordCustomFieldService

All Superinterfaces:

BaseCustomFieldService<RecordCustomFieldDTO,RecordCustomFieldData,RecordTypeVO>, CRUDService<RecordCustomFieldDTO,RecordCustomFieldData,RecordTypeVO>, Service

All Known Subinterfaces:

RecordCustomFieldServiceLocal

All Known Implementing Classes:

RecordCustomFieldServiceSecurity

public interface RecordCustomFieldService
extends BaseCustomFieldService<RecordCustomFieldDTO,RecordCustomFieldData,RecordTypeVO>

Service interface for record custom fields

Author:

luis

Method Summary

Modifier and Type	Method and Description
void	linkShared(RecordTypeVO recordType, CustomFieldVO customField) Relates the given record type with the given custom field
java.util.List<CustomFieldDetailedVO>	list(RecordTypeVO recordType) Lists the fields in the given record type returning also the shared ones.
java.util.List<CustomFieldDetailedVO>	listShared() Lists the shared fields
void	saveOrderOnType(RecordTypeVO recordType, java.util.List<CustomFieldVO> customFields) Saves the order of the given custom field.
void	unlinkShared(RecordTypeVO recordType, CustomFieldVO customField) Removes the link that exists between the record type and the shared field

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

saveOrder

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

linkShared

void linkShared(@NotNull
                RecordTypeVO recordType,
                @NotNull
                CustomFieldVO customField)
         throws FrameworkException

Relates the given record type with the given custom field

Throws:

FrameworkException

list

java.util.List<CustomFieldDetailedVO> list(@NotNull
                                           RecordTypeVO recordType)
                                    throws FrameworkException

Lists the fields in the given record type returning also the shared ones.

Throws:

FrameworkException

listShared

java.util.List<CustomFieldDetailedVO> listShared()
                                          throws FrameworkException

Lists the shared fields

Throws:

FrameworkException

saveOrderOnType

void saveOrderOnType(@NotNull
                     RecordTypeVO recordType,
                     @NotNull
                     java.util.List<CustomFieldVO> customFields)
              throws FrameworkException

Saves the order of the given custom field.

Throws:

FrameworkException

unlinkShared

void unlinkShared(@NotNull
                  RecordTypeVO recordType,
                  @NotNull
                  CustomFieldVO customField)
           throws FrameworkException

Removes the link that exists between the record type and the shared field

Throws:

FrameworkException