com.draeger.medical.biceps.common.model

Class State

java.lang.Object

com.draeger.medical.biceps.common.model.State

Direct Known Subclasses:

AbstractAlertState, AbstractContextState, ClockState, ComponentState, OperationState

public class State
extends Object

AbstractState defines foundational meta information of any object that is included in the state part of the MDIB (hence, MDState includes a set of AbstractState objects). Any state object is derived from AbstractState. The AbstractState's counterpart is AbstractDescriptor.

Field Summary

Fields

Modifier and Type	Field and Description
protected BigInteger	descriptorVersion
protected Extension	extension
protected String	handle
protected String	referencedDescriptor
protected BigInteger	stateVersion

Constructor Summary

Constructors

Constructor and Description
State()

Method Summary

Modifier and Type	Method and Description
BigInteger	getDescriptorVersion() The current version of the descriptor to that this state belongs to.
Extension	getExtension() Gets the value of the extension property.
String	getHandle() An optional name to uniquely identify a state.
String	getReferencedDescriptor() The handle reference of a descriptor to that this state belongs to.
BigInteger	getStateVersion() A state's version number increased by one with every state modification.
void	setDescriptorVersion(BigInteger value) Sets the value of the descriptorVersion property.
void	setExtension(Extension value) Sets the value of the extension property.
void	setHandle(String value) Sets the value of the handle property.
void	setReferencedDescriptor(String value) Sets the value of the referencedDescriptor property.
void	setStateVersion(BigInteger value) Sets the value of the stateVersion property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

extension

protected Extension extension

handle

protected String handle

stateVersion

protected BigInteger stateVersion

referencedDescriptor

protected String referencedDescriptor

descriptorVersion

protected BigInteger descriptorVersion

Constructor Detail

State

public State()

Method Detail

getExtension

public Extension getExtension()

Gets the value of the extension property.

Returns:

possible object is Extension

setExtension

public void setExtension(Extension value)

Sets the value of the extension property.

Parameters:

value - allowed object is Extension

getHandle

public String getHandle()

An optional name to uniquely identify a state. Handle names are only required if the relation to a descriptor is ambiguous. The semantics are as follows: - A state SHALL not own a handle attribute if it is and will be the only state belonging to a descriptor (defined as a single state). Single states are uniquely identifiable by the corresponding descriptor handle. - A state SHALL own a handle attribute if it is a multi state. A state is a multi state if there are or will be other states referencing the same descriptor. - The handle of two states SHALL be equal if and only if they describe the same state even so in a different MDIB/State version. From this it follows that a state is a single state if it not possesses a handle attribute and a state is a multi state if it possesses a handle attribute.

Returns:

possible object is String

setHandle

public void setHandle(String value)

Sets the value of the handle property.

Parameters:

value - allowed object is String

getStateVersion

public BigInteger getStateVersion()

A state's version number increased by one with every state modification. The implied value for the initial state instance SHALL be "0".

Returns:

possible object is BigInteger

setStateVersion

public void setStateVersion(BigInteger value)

Sets the value of the stateVersion property.

Parameters:

value - allowed object is BigInteger

getReferencedDescriptor

public String getReferencedDescriptor()

The handle reference of a descriptor to that this state belongs to.

Returns:

possible object is String

setReferencedDescriptor

public void setReferencedDescriptor(String value)

Sets the value of the referencedDescriptor property.

Parameters:

value - allowed object is String

getDescriptorVersion

public BigInteger getDescriptorVersion()

The current version of the descriptor to that this state belongs to.

Returns:

possible object is BigInteger

setDescriptorVersion

public void setDescriptorVersion(BigInteger value)

Sets the value of the descriptorVersion property.

Parameters:

value - allowed object is BigInteger