com.cloupia.service.cIM.inframgr

Class CustomFeatureRegistry

java.lang.Object

com.cloupia.service.cIM.inframgr.CustomFeatureRegistry

public final class CustomFeatureRegistry
extends java.lang.Object

Provides APIs for developers to introduce various objects into the system. Developers will want to use this to add their own LOV providers and validators. Most of these APIs never have to be used directly as they are indirectly called through the framework.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPEN_AUTOMATION_COMMUNITY_EXPERIMENTAL_ID
static java.lang.String	OPEN_AUTOMATION_COMMUNITY_EXPERIMENTAL_LABEL
static java.lang.String	OPEN_AUTOMATION_COMMUNITY_VALIDATED_ID
static java.lang.String	OPEN_AUTOMATION_COMMUNITY_VALIDATED_LABEL

Method Summary

Modifier and Type	Method and Description
static CustomFeatureRegistry	getInstance()
void	registerFieldValidator(java.lang.String name, FieldValidatorIf validator) Add a new validator into the system.
void	registerForms(java.lang.String formId, FormBackendResolverIf form) This is where the framework registers the forms
void	registerLovProviders(java.lang.String name, LOVProviderIf lovProvider) Add a new LOV provider into the system.
PodDefinition	registerPodDefinition(java.lang.String featureId) Method to register POD definition to pod definitions map
void	registerReports(ReportRegistryEntry entry) This is where the reports are registered by the frame work.
void	registerTabularField(java.lang.String name, java.lang.Class reportImplementation, java.lang.String selectionColumnId, java.lang.String displayColumnId) Add a new tabular data source into the system.
void	registerTaskCategory(java.lang.String id, java.lang.String parentId, java.lang.String label, java.util.Properties properties) Use this method to add new task categories into CUIC.
void	registerWorkflowInputFieldType(java.lang.String inputType, java.lang.String label, int fieldType, java.lang.String lovProvider) Add a new workflow input field type into the system.
void	registerWorkflowInputFieldType(java.lang.String inputType, java.lang.String label, int fieldType, java.lang.String lovProvider, boolean isMultiSelect, UserInputValidatorIf val) Add a new workflow input field type into the system.
void	registerWorkflowTask(WFTaskDefinition def, java.util.Properties properties) Use this method to add a new workflow task into CUIC.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPEN_AUTOMATION_COMMUNITY_EXPERIMENTAL_ID

public static final java.lang.String OPEN_AUTOMATION_COMMUNITY_EXPERIMENTAL_ID

See Also:

Constant Field Values

OPEN_AUTOMATION_COMMUNITY_EXPERIMENTAL_LABEL

public static final java.lang.String OPEN_AUTOMATION_COMMUNITY_EXPERIMENTAL_LABEL

See Also:

Constant Field Values

OPEN_AUTOMATION_COMMUNITY_VALIDATED_ID

public static final java.lang.String OPEN_AUTOMATION_COMMUNITY_VALIDATED_ID

See Also:

Constant Field Values

OPEN_AUTOMATION_COMMUNITY_VALIDATED_LABEL

public static final java.lang.String OPEN_AUTOMATION_COMMUNITY_VALIDATED_LABEL

See Also:

Constant Field Values

Method Detail

getInstance

public static CustomFeatureRegistry getInstance()

registerReports

public void registerReports(ReportRegistryEntry entry)
                     throws java.lang.Exception

This is where the reports are registered by the frame work.

Parameters:

entry - - the report registry entry

Throws:

java.lang.Exception

registerForms

public void registerForms(java.lang.String formId,
                          FormBackendResolverIf form)
                   throws java.lang.Exception

This is where the framework registers the forms

Parameters:

formId - - the formId of the form

form - - the form

Throws:

java.lang.Exception

registerWorkflowTask

public void registerWorkflowTask(WFTaskDefinition def,
                                 java.util.Properties properties)
                          throws java.lang.Exception

Use this method to add a new workflow task into CUIC.

Parameters:

def - The task definition containing all the necessary parameters for a workflow task.

properties - The properties should be packaged in your module, you can access it from module.getProperties().

Throws:

java.lang.Exception - Thrown when the config class of the definition's table name does not start with the feature ID. E.g. Your featureID is "abc" but you used @PersistenceCapable(table = "some_table"), an exception is thrown. However if you did table = "abc_some_table", then it's acceptable. Thrown if handler type is not unique. If you try to register two different definitions but they share the same handler then it will throw an exception.

registerTaskCategory

public void registerTaskCategory(java.lang.String id,
                                 java.lang.String parentId,
                                 java.lang.String label,
                                 java.util.Properties properties)
                          throws java.lang.Exception

Use this method to add new task categories into CUIC.

Parameters:

id - A unique String for the new category you are creating.

parentId - If null, this new category will be placed under Open Automation Community Tasks -> Experimental or Validated, depending on the state of your module. If parentId is not null, it should provide the same string id used to register a previous category.

label - The string value shown in UI for this category.

properties - The properties should be packaged in your module, you can access it from module.getProperties().

Throws:

java.lang.Exception - Thrown when attempting to use an ID already in use. Or when properties is missing or invalid.

registerTabularField

public void registerTabularField(java.lang.String name,
                                 java.lang.Class reportImplementation,
                                 java.lang.String selectionColumnId,
                                 java.lang.String displayColumnId)
                          throws java.lang.Exception

Add a new tabular data source into the system. For tabular controls, the data source is a class that implements TabularReportGeneratorIf.

Parameters:

name - A unique identifier for the LOV provider.

reportImplementation - The class implementing TabularReportGeneratorIf.

selectionColumnId - The column index designated for selection purposes, usually "0" is sufficient.

displayColumnId - The column index used to display values for TabularSelectAreas, usually "0" is sufficient.

Throws:

java.lang.Exception - An exception is thrown if a tabular field already exists with the same name.

registerWorkflowInputFieldType

public void registerWorkflowInputFieldType(java.lang.String inputType,
                                           java.lang.String label,
                                           int fieldType,
                                           java.lang.String lovProvider)
                                    throws java.lang.Exception

Add a new workflow input field type into the system.

Parameters:

inputType - - the input type

label - - the label of the new filed type

fieldType - - the type of the field

lovProvider - - the lov providers name

Throws:

java.lang.Exception

registerWorkflowInputFieldType

public void registerWorkflowInputFieldType(java.lang.String inputType,
                                           java.lang.String label,
                                           int fieldType,
                                           java.lang.String lovProvider,
                                           boolean isMultiSelect,
                                           UserInputValidatorIf val)
                                    throws java.lang.Exception

Add a new workflow input field type into the system.

Parameters:

inputType - - the input type

label - - the label of the new filed type

fieldType - - the type of the field

lovProvider - - the lov providers name

isMultiSelect - - is multi select

Throws:

java.lang.Exception

registerLovProviders

public void registerLovProviders(java.lang.String name,
                                 LOVProviderIf lovProvider)
                          throws java.lang.Exception

Add a new LOV provider into the system.

Parameters:

name - A unique identifier for the LOV provider.

lovProvider - An instance of the LOV provider.

Throws:

java.lang.Exception - An exception is thrown if there is an existing LOV provider with the same name.

registerFieldValidator

public void registerFieldValidator(java.lang.String name,
                                   FieldValidatorIf validator)
                            throws java.lang.Exception

Add a new validator into the system.

Parameters:

name - A unique identifier for the validator.

validator - An instance of the implementation of FieldValidatorIf.

Throws:

java.lang.Exception - An exception is thrown if there is an existing validator with the same name.

registerPodDefinition

public final PodDefinition registerPodDefinition(java.lang.String featureId)
                                          throws java.lang.Exception

Method to register POD definition to pod definitions map

Parameters:

featureId -

Returns:

Throws:

java.lang.Exception