CIP JAVA documentation for class "com.ptc.pfc.pfcModelCheck.ModelCheckCustomCheckListener"

Interface ModelCheckCustomCheckListener

package com.ptc.pfc.pfcModelCheck; public interface ModelCheckCustomCheckListener extends com.ptc.pfc.pfcBase.ActionListener

Description

This interface should be extended to provide the implementation for a ModelCheck custom check.

Method Summary
`CustomCheckResults`	`OnCustomCheck (String CheckName, Model Mdl)` Override this method to evaluate a ModelCheck externally defined check.
`void`	`OnCustomCheckAction (String CheckName, Model Mdl, /optional/ String SelectedItem)` Override this method to execute a repair action on an item found by a custom check.
`void`	`OnCustomCheckUpdate (String CheckName, Model Mdl, /optional/ String SelectedItem)` Override this method to update an item found by a custom check.

Method Detail

OnCustomCheck

CustomCheckResults OnCustomCheck (String CheckName, Model Mdl)

Override this method to evaluate a ModelCheck externally defined check.

Parameters:

Returns:: The CustomCheckResults object containing the results of the check for this model.

OnCustomCheckAction

void OnCustomCheckAction (String CheckName, Model Mdl, /*optional*/ String SelectedItem)

Override this method to execute a repair action on an item found by a custom check.

Parameters:

CheckName: Name of the check.
Mdl: The model.
SelectedItem: Label of the item that was selected from the table, if applicable. This will match the value of string returned in the CustomCheckResults object returned by ModelCheckCustomCheckListener.OnCustomCheck(String, Model). Can be null if no item was selected.

OnCustomCheckUpdate

void OnCustomCheckUpdate (String CheckName, Model Mdl, /*optional*/ String SelectedItem)

Override this method to update an item found by a custom check.

Parameters:

CheckName: Name of the check.
Mdl: The model.
SelectedItem: Label of the item that was selected from the table,if applicable. This will match the value of string returned in the CustomCheckResults object returned by ModelCheckCustomCheckListener.OnCustomCheck(String, Model).