ExtensionService (eframe 0.5 API)

org.simplemes.eframe.custom.service.ExtensionService

@groovy.util.logging.Slf4j
@groovy.lang.Singleton
class ExtensionService
extends java.lang.Object

Provides access to the extensions that allow user to customize the GUI and application.

Constructor Summary

Constructors
Constructor and description
`ExtensionService ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`boolean`	`canBeAvailable(java.lang.Class domainClass, java.lang.String fieldName)` Returns true if the given field can be in the available list.
	`int`	`deleteField(java.lang.String id)` Deletes a custom field and it use in the field order for the domain.
	`java.lang.String`	`determineFieldType(java.lang.String fieldName, FieldFormatInterface format)` Determines the field type for the Configuration GUI use.
	`groovy.lang.Tuple2<java.util.List<java.util.Map>, java.util.List<java.util.Map>>`	`getExtensionConfiguration(java.lang.Class domainClass)` Finds the current extension configuration for a given domain.
	`void`	`saveFieldOrder(java.lang.Class domainClass, java.util.List<java.lang.String> newFieldOrder)` Saves the new field order as configured by the user in the Configuration GUI for a definition page.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - ExtensionService()
- Method Detail
  - boolean canBeAvailable(java.lang.Class domainClass, java.lang.String fieldName)
    
    Returns true if the given field can be in the available list. Also helps filter out field that start with '_'.
    Parameters:
    domainClass - The domain Class.
    fieldName - The field in the domain class.
    Returns:
    True if the field can be in the available list.
  - @javax.transaction.Transactional int deleteField(java.lang.String id)
    
    Deletes a custom field and it use in the field order for the domain.
    Parameters:
    id - The ID of the FieldExtension record.
    Returns:
    The number of FieldExtension records deleted.
  - java.lang.String determineFieldType(java.lang.String fieldName, FieldFormatInterface format)
    
    Determines the field type for the Configuration GUI use. Gives a hint on the appearance of the field.
    Parameters:
    fieldName - The field name.
    format - The field format.
    Returns:
    The type (e.g. 'dateField',etc).
  - @javax.transaction.Transactional groovy.lang.Tuple2<java.util.List<java.util.Map>, java.util.List<java.util.Map>> getExtensionConfiguration(java.lang.Class domainClass)
    
    Finds the current extension configuration for a given domain. This returns the available and configured list of fields in two lists.
    Fields
    The lists contain maps with these fields:
    - name - The field name.
    - label - The field label (localized).
    - type - The field type (e.g. 'textField', 'dateField', etc).
    - custom - True if the field is a custom field.
    Parameters:
    domainClass - The domain class to return the current config for.
    Returns:
    A list of available fields and a list of configured fields.
  - @javax.transaction.Transactional void saveFieldOrder(java.lang.Class domainClass, java.util.List<java.lang.String> newFieldOrder)
    
    Saves the new field order as configured by the user in the Configuration GUI for a definition page.
    Parameters:
    domainClass - The domain class to return the current config for.

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class ExtensionService

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

ExtensionService()

Method Detail

boolean canBeAvailable(java.lang.Class domainClass, java.lang.String fieldName)

@javax.transaction.Transactional int deleteField(java.lang.String id)

java.lang.String determineFieldType(java.lang.String fieldName, FieldFormatInterface format)

@javax.transaction.Transactional groovy.lang.Tuple2<java.util.List<java.util.Map>, java.util.List<java.util.Map>> getExtensionConfiguration(java.lang.Class domainClass)

Fields

@javax.transaction.Transactional void saveFieldOrder(java.lang.Class domainClass, java.util.List<java.lang.String> newFieldOrder)