org.openhealthexchange.openpixpdq.ihe.configuration
Interface IheActorDescription

All Known Implementing Classes:

ConfigurationLoader.ActorDescription, ConfigurationLoader.PixManagerActorDescription

public interface IheActorDescription

This interface is used to access the properties of IHE Actor definition. Typically IHE Actors are defined in XML configuration files and loaded by the ConfigurationLoader.

Version:

1.0 - Jan 10, 2006

Author:

Jim Firby

See Also:

ConfigurationLoader

Method Summary

java.lang.String	getActorType() Gets the actor type of this actor (i.e.
java.lang.String	getDescription() Gets a human-readable description of this actor.
java.lang.String	getId() Gets a unique ID for this actor.
java.lang.String	getType() Gets a human-readable string naming the type of this actor (ie.
boolean	isInstalled() Returns true if this actor is believed to be installed into a broker.

Method Detail

getDescription

java.lang.String getDescription()

Gets a human-readable description of this actor. This description can be used in a GUI to name this actor.

Returns:

a human-readable description of this actor

getId

java.lang.String getId()

Gets a unique ID for this actor. This ID can be used to look the actor up in the ConfigurationLoader. The ID is not intended for use in a GUI.

Returns:

the id

getType

java.lang.String getType()

Gets a human-readable string naming the type of this actor (ie. "PDQ Server", "PIX Manager", "Audit Repository"). All actors of the same type will return the same string. The type is designed to be used in a GUI.

Returns:

the type

getActorType

java.lang.String getActorType()

Gets the actor type of this actor (i.e. "PdSupplier", "PixManager", "SecureNode"). This type is for machine process, not meant to be used by GUI. It is also different from the above human-readable type.

Returns:

the actor type

isInstalled

boolean isInstalled()

Returns true if this actor is believed to be installed into a broker. False otherwise.

Returns:

true if this actor is believed to be installed