org.openepics.cable.jaxb

Interface CableResource

All Known Implementing Classes:

CableResourceImpl

public interface CableResource

This resource provides bulk cables and specific cable data.

Author:

Sunil Sah

Method Summary

Modifier and Type	Method and Description
List<CableElement>	getAllCables(List<String> field, String regExp) Returns non-deleted cables in the database.
List<CableElement>	getAllCablesWithESSName(String essName)
List<CableElement>	getAllCablesWithFBSTag(String fbsTag)
List<CableElement>	getAllCablesWithLBSTag(String lbsTag)
CableElement	getCable(String name) Returns a specific cable instance.

Method Detail

getAllCables

List<CableElement> getAllCables(List<String> field,
                                String regExp)

Returns non-deleted cables in the database. The cables are optionally filtered by matching cable properties using regular expression.

Parameters:

field - a list of string cable fields to search using regular expression; if empty, all fields are searched

regExp - the regular expression to use to search the cables; if null or empty, all cables are returned

Returns:

the cables

getCable

CableElement getCable(String name)

Returns a specific cable instance.

Parameters:

name - the name of the cable to retrieve

Returns:

the cable instance data

getAllCablesWithESSName

List<CableElement> getAllCablesWithESSName(String essName)

getAllCablesWithFBSTag

List<CableElement> getAllCablesWithFBSTag(String fbsTag)

getAllCablesWithLBSTag

List<CableElement> getAllCablesWithLBSTag(String lbsTag)