Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • clientId: (Optional) File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD. If not provided then no id mapping will be done.
  • filterId: Filter Id. Can be retrieved using the String getFilters(String piVersion) method.
  • piVersion: (Optional) Pi Version for the return file. Defaults to the latest PI version.
  • returns: String content of a Pi_TimeSeriesParameters XML file containing the parameters available for passed filter id.

h4: Client datasets

Code Block

String[] getAllNodesWithDataset();

Retrieves all identifiers of sgement nodes holding one or more client datasets

  • returns: Array of string identifiers of nodes
Code Block

String[] getAllDataSetsIdsForNode(String nodeId, String clientId);

Retrieves all identifiers to client datasets available for this segement node

  • clientId: (Optional) File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD.
  • nodeId: Segment node identifier
  • returns: Array of string identifiers referring to client datasets
Code Block

String getDescription(String id, String clientId)

Retrieves description of a specific client dataset from the local datastore

  • clientId: (Optional) File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD.
  • id: Identifier of client dataset
  • returns: String description of dataset content
Code Block

byte[] getDataSet(String id, String clientId)

...

Retrieves latest time when a client dataset has been modified

  • returns: Modifcation Time as Long (modified Julian date)

Setter methods

Code Block
void setSystemTime(Date systemTime);

...