com.inductiveautomation.reporting.client

Class ReportingClientHook

java.lang.Object

com.inductiveautomation.vision.api.client.AbstractClientModuleHook

com.inductiveautomation.reporting.client.ReportingClientHook

All Implemented Interfaces:

ClientModuleHook

public class ReportingClientHook
extends AbstractClientModuleHook

Constructor Summary

Constructors

Constructor and Description
ReportingClientHook()

Method Summary

Modifier and Type	Method and Description
void	addComponent(ILicenseAwareComponent component)
void	configureDeserializer(XMLDeserializer deserializer) Called when an XMLDeserializer is created.
void	initializeScriptManager(ScriptManager manager) Initialize a newly-instantiated script manager.
void	notifyActivationStateChanged(LicenseState licenseState) Notifies this client module that it's license state has changed.
void	removeComponent(ILicenseAwareComponent component)
protected void	setupRM14()
void	shutdown() Called when the module is shut down.
void	startup(ClientContext context, LicenseState activationState) The main entrypoint for the module hook.

Methods inherited from class com.inductiveautomation.vision.api.client.AbstractClientModuleHook

configureFunctionFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportingClientHook

public ReportingClientHook()

Method Detail

configureDeserializer

public void configureDeserializer(XMLDeserializer deserializer)

Description copied from interface: ClientModuleHook

Called when an XMLDeserializer is created. Gives the module a chance to add custom deserialization delegates to the deserializer.

Specified by:

configureDeserializer in interface ClientModuleHook

Overrides:

configureDeserializer in class AbstractClientModuleHook

notifyActivationStateChanged

public void notifyActivationStateChanged(LicenseState licenseState)

Description copied from interface: ClientModuleHook

Notifies this client module that it's license state has changed. Note that if the trial mode expires, the entire client will automatically time out, so client modules don't typically need to worry about trial mode.

Specified by:

notifyActivationStateChanged in interface ClientModuleHook

Overrides:

notifyActivationStateChanged in class AbstractClientModuleHook

shutdown

public void shutdown()

Description copied from interface: ClientModuleHook

Called when the module is shut down.

Specified by:

shutdown in interface ClientModuleHook

Overrides:

shutdown in class AbstractClientModuleHook

startup

public void startup(ClientContext context,
                    LicenseState activationState)
             throws java.lang.Exception

Description copied from interface: ClientModuleHook

The main entrypoint for the module hook. This will only be called once for a given project. If another project is ever opened, ClientModuleHook.shutdown() will be called and a new hook will be instantiated

Specified by:

startup in interface ClientModuleHook

Overrides:

startup in class AbstractClientModuleHook

Throws:

java.lang.Exception - if the module was not able to be initialized for the given project.

setupRM14

protected void setupRM14()

addComponent

public void addComponent(ILicenseAwareComponent component)

removeComponent

public void removeComponent(ILicenseAwareComponent component)

initializeScriptManager

public void initializeScriptManager(ScriptManager manager)

Description copied from interface: ClientModuleHook

Initialize a newly-instantiated script manager. This will be called exactly once for any given ScriptManager instance. Usually this will involve calling ScriptManager.addScriptModule(String, Object), which reflectively loads the public (instance and static) java functions from the given object into the scripting environment, at the provided path.

Specified by:

initializeScriptManager in interface ClientModuleHook

Overrides:

initializeScriptManager in class AbstractClientModuleHook