org.openepics.cable.services

Interface Names

All Superinterfaces:

Serializable

All Known Implementing Classes:

NamesServiceCache

public interface Names
extends Serializable

Interface for providing custom implementation to get names.

Author:

Andraž Požar, Miha Vitorovič, Sunil Sah

Method Summary

Modifier and Type	Method and Description
Set<String>	getActiveNames() Returns a set of all active names
Map<String,org.openepics.names.jaxb.DeviceNameElement>	getAllNames() Returns a map of all names
String	getNameByUuid(String uuid) Returns a name with the given uuid.
NameStatus	getNameStatus(String name) Returns the status of the name.
String	getUuidByName(String name) Returns a uuid of the name.
boolean	isError()
void	refresh() Refreshes the names, for example by clearing cache and reloading

Method Detail

isError

boolean isError()

Returns:

true if there was an error constructing a list of names, false otherwise

refresh

void refresh()

Refreshes the names, for example by clearing cache and reloading

getAllNames

Map<String,org.openepics.names.jaxb.DeviceNameElement> getAllNames()

Returns a map of all names

Returns:

a map of names

getActiveNames

Set<String> getActiveNames()

Returns a set of all active names

Returns:

a set of names

getNameStatus

NameStatus getNameStatus(String name)

Returns the status of the name.

Parameters:

name - the name

Returns:

status of the name

getNameByUuid

String getNameByUuid(String uuid)

Returns a name with the given uuid. If the name status is OBSOLETE, null is returned.

Parameters:

uuid - uuid of the name

Returns:

name of the device or null if not found or obsolete

getUuidByName

String getUuidByName(String name)

Returns a uuid of the name.

Parameters:

name - device name

Returns:

UUID of the name or null if name not found