Actions Implementing Public Interfaces |
Content |
|||||||||||||
|
Overview |
|
|
Most LabVantage System Action classes implement public Interfaces (in sapphire.action) that declare properties for the Action. For example, the AddSDI Action class is declared as
public class AddSDI extends BaseSDIAction implements sapphire.action.AddSDI {
The corresponding interface sapphire.action.AddSDI declares all properties associated with the AddSDI Action. Use the Interfaces to set/get properties of a System Action. For example, to set the sdcid input property of AddSDI:
PropertyList actionProps = new PropertyList();
actionProps.setProperty( sapphire.action.AddSDI.PROPERTY_SDCID, "Sample"
);
Locations |
|
|
The public Interfaces are in the Java Public API in the sapphire.action package. Descriptions of LabVantage System Actions that implement public Interfaces are listed in the Table of Contents under API References → System Actions → Actions Implementing Public Interfaces → Action Javadoc. This link in the Table of Contents opens a custom window containing the Javadoc for System Action Public Interfaces (the link on this page opens the Javadoc in a standard blank window). This frameset is built by a specially modified Javadoc that parses comments in the Interface code and renders them to show "Input Properties"," Output Properties", and any available "Additional Information".
LabVantage System Actions that do not implement public Interfaces are listed in the Table of Contents under API References → System Actions → Other Actions.