CIP JAVA documentation for class "com.ptc.pfc.pfcRelations.RelationFunctionListener"

Interface RelationFunctionListener

package com.ptc.pfc.pfcRelations; public interface RelationFunctionListener extends com.ptc.pfc.pfcBase.ActionListener

Description

Listener providing the implementation for external functions registered by this application and capable of being used in relations.

Method Summary
`void`	`AssignValue (RelationOwner Owner, String FunctionName, ParamValues Arguments, ParamValue Assignment)` Function called to evaluate a custom relation function invoked on the left hand side of a relation.
`boolean`	`CheckArguments (RelationOwner Owner, String FunctionName, ParamValues Arguments)` To check the validity of arguments of external function.
`ParamValue`	`EvaluateFunction (RelationOwner Owner, String FunctionName, ParamValues Arguments)` Function called to evaluate a custom relation function invoked on the right hand side of a relation.

Method Detail

CheckArguments

boolean CheckArguments (RelationOwner Owner, String FunctionName, ParamValues Arguments)

To check the validity of arguments of external function.

This method can be used to check the contents of the arguments. If you want to restrict the arguments to be a certain number and a certain type, use the optional argument RelationFunctionOptions.GetArgumentTypes(/*optional*/ RelationFunctionArguments) instead.

Manual References:: Relations: Relation Function Listeners, Relations: Relation Function Listeners

Parameters:

Owner: Owner item of the relations
FunctionName: Name of the external function.
Arguments: Arguments passed by the relation to the external function.

Returns:: true or false depending on the check.

EvaluateFunction

ParamValue EvaluateFunction (RelationOwner Owner, String FunctionName, ParamValues Arguments)

Function called to evaluate a custom relation function invoked on the right hand side of a relation.

Manual References:: Relations: Relation Function Listeners

Parameters:

Owner: Owner item of the relations
FunctionName: Name of the external function.
Arguments: Arguments passed by the relation to the external function.

Returns:: The result of the relation function calculation.

AssignValue

void AssignValue (RelationOwner Owner, String FunctionName, ParamValues Arguments, ParamValue Assignment)

Function called to evaluate a custom relation function invoked on the left hand side of a relation.

Manual References:: Relations: Relation Function Listeners, Relations: Relation Function Listeners

Parameters:

Owner: Owner item of the relations
FunctionName: Name of the external function.
Arguments: Arguments passed by the relation to the external function.
Assignment: The right hand side of the relation to be used in the assignment.

Returns: