org.kuali.rice.krms.impl.ui

Class CustomOperatorUiTranslator

java.lang.Object

org.kuali.rice.krms.impl.ui.CustomOperatorUiTranslator

public class CustomOperatorUiTranslator
extends Object

Utility service used by the KRMS agenda editing UI for display and access to custom operators.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Constructor Summary

Constructors

Constructor and Description
CustomOperatorUiTranslator()

Method Summary

Methods

Modifier and Type	Method and Description
CustomOperator	getCustomOperator(String customOperatorFormValue) Gets the service instance given the specially formatted form value.
String	getCustomOperatorName(String customOperatorFormValue) Gets the custom operator function name which is used for display purposes
boolean	isCustomOperatorFormValue(String formValue) Checks if a form value represents a custom operator.
QName	parseCustomOperatorServiceQName(String customOperatorFormValue) Parses the QName for the custom operator service from the form value string, which has the format customOperator:<Namespace>:<serviceName>

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomOperatorUiTranslator

public CustomOperatorUiTranslator()

Method Detail

parseCustomOperatorServiceQName

public QName parseCustomOperatorServiceQName(String customOperatorFormValue)

Parses the QName for the custom operator service from the form value string, which has the format customOperator:<Namespace>:<serviceName>

Parameters:

customOperatorFormValue -

Returns:

the QName for the custom operator service

getCustomOperatorName

public String getCustomOperatorName(String customOperatorFormValue)

Gets the custom operator function name which is used for display purposes

Parameters:

customOperatorFormValue - the form value representing the custom operator

Returns:

getCustomOperator

public CustomOperator getCustomOperator(String customOperatorFormValue)

Gets the service instance given the specially formatted form value.

The form value contains the namespace and name of the service, which is used internally for retrieval.

Parameters:

customOperatorFormValue - the custom operator form value

Returns:

the custom operator service instance

Throws:

IllegalArgumentException - if the customOperatorFormValue is null or is formatted incorrectly

isCustomOperatorFormValue

public boolean isCustomOperatorFormValue(String formValue)

Checks if a form value represents a custom operator.

The determination is made be checking for a special prefix value that is used by convention.

Parameters:

formValue - the form value to check

Returns:

true if the form value represents a custom operator.