Package org.cyclos.services.users

Interface RecordCustomFieldService

All Superinterfaces:

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

All Known Subinterfaces:

RecordCustomFieldServiceLocal

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

Service interface for record custom fields

Method Summary

Modifier and Type	Method	Description
void	linkShared(@NotNull RecordTypeVO recordType, @NotNull CustomFieldVO customField)	Relates the given record type with the given custom field
List<RecordCustomFieldVO>	list(@NotNull RecordTypeVO recordType)	Lists the fields in the given record type returning also the shared ones.
List<CustomFieldVO>	listShared()	Lists all the available shared fields
void	saveOrderOnType(@NotNull RecordTypeVO recordType, @NotNull List<CustomFieldVO> customFields)	Saves the order of the given custom field.
void	unlinkShared(@NotNull RecordTypeVO recordType, @NotNull 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
                @NotNull RecordTypeVO recordType,
                @NotNull
                @NotNull CustomFieldVO customField)
         throws FrameworkException

Relates the given record type with the given custom field

Throws:

FrameworkException

list

List<RecordCustomFieldVO> list(@NotNull
                               @NotNull RecordTypeVO recordType)
                        throws FrameworkException

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

Throws:

FrameworkException

listShared

List<CustomFieldVO> listShared()
                        throws FrameworkException

Lists all the available shared fields

Throws:

FrameworkException

saveOrderOnType

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

Saves the order of the given custom field.

Throws:

FrameworkException

unlinkShared

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

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

Throws:

FrameworkException