MedicalDeviceInformationBase (BICEPS 0.6.1 API)

All Known Implementing Classes:

DefaultMedicalDeviceInformationBase
```
public interface MedicalDeviceInformationBase
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`create(MDDescription mdDescription)` Create a MDIB using the provided description.
`void`	`create(MDDescription mdib, MDState initialMDState)` Create a MDIB using the provided description and the initial state.
`void`	`createWithExistingLock(MDDescription mdDescription, MDState initialMDState, ReadWriteLock mdibLock)` Create a MDIB using the provided description and the initial state and uses the provided lock for all read or write access to the MDIB.
`void`	`createWithExistingLock(MDDescription mdDescription, ReadWriteLock mdibLock)` Create a MDIB using the provided description and uses the provided lock for all read or write access to the MDIB.
`AlertConditionDescriptor`	`getAlertConditionDescriptor(String handle)`
`Collection<? extends AbstractAlertDescriptor>`	`getAlertDescriptors(Collection<String> handles)`
`AlertSignalDescriptor`	`getAlertSignalDescriptor(String handle)`
`Collection<? extends AbstractAlertState>`	`getAlertStates(Collection<String> handles)`
`Collection<? extends AlertSystemDescriptor>`	`getAlertSystemDescriptions(Collection<String> handles)` Returns the current descriptions for the alert systems that are specified with the handles collection.
`AlertSystemDescriptor`	`getAlertSystemDescriptor(String handle)` Returns the current description for the alert system that is specified with the handle.
`Collection<Descriptor>`	`getAllDescriptors()`
`ContainmentTree`	`getContainmentTree(String referencedDescriptor)`
`ContainmentTreeEntry`	`getContainmentTreeEntry(String referencedDescriptor)`
`Collection<? extends ContextAssociationStateValue>`	`getContextAssociationStateValues(List<String> handles)`
`Descriptor`	`getDescriptor(String referencedDescriptor)`
`MDDescription`	`getDeviceDescriptions()` Returns the current descriptions of the medical devices contained in the MDIB.
`MDState`	`getDeviceStates()` Returns the current states of the medical devices contained in the MDIB.
`String`	`getHandle(Object o)`
`<T extends AbstractContextState> Collection<T>`	`getIdentifiableContextState(List<String> handles, Class<T> contentClass)`
`MedicalDeviceInformationBaseManager`	`getManager()` Return the Manager that should be used for all direct modifications to the MDIB.
`ReadWriteLock`	`getMdibLock()` Returns the Lock that should be used for locking the MDIB for Read/Write Operations.
`BigInteger`	`getMdibStateVersion()`
`String`	`getMDSDescriptionHandleForOperation(String ophandle)`
`Collection<? extends MDSDescriptor>`	`getMDSDescriptions(Collection<String> handles, boolean onlyNonComposite)`
`MDSDescriptor`	`getMDSForDescriptor(String handle)`
`Collection<? extends MDSState>`	`getMDSStates(Collection<String> handles, boolean onlyNonComposite)`
`Collection<? extends MetricDescriptor>`	`getMetricDescriptors(Collection<String> handles)` Returns the current descriptors for the metrics that are specified with the handles collection.
`Collection<? extends AbstractMetricState>`	`getMetricStates(Collection<String> handles)` Returns the current states for the metrics that are specified with the handles collection.
`OperationDescriptor`	`getOperationDescriptor(String operationHandle)` Returns the current description for the operations that is specified with the handle.
`Collection<? extends OperationDescriptor>`	`getOperationForOperationTarget(String operationTargetHandle)`
`State`	`getState(String stateHandle)`

- Method Detail
  - create
```
void create(MDDescription mdDescription)
```
    Create a MDIB using the provided description. The initial state of the created MDIB is an empty set.
    
    Parameters:
    
    mdDescription - The description of the medical devices that should be used to create the MDIB.
  - create
```
void create(MDDescription mdib,
            MDState initialMDState)
```
    Create a MDIB using the provided description and the initial state.
    
    Parameters:
    
    mdib - the mdib
    
    initialMDState - the initial md state
  - createWithExistingLock
```
void createWithExistingLock(MDDescription mdDescription,
                            ReadWriteLock mdibLock)
```
    Create a MDIB using the provided description and uses the provided lock for all read or write access to the MDIB.
    
    Parameters:
    
    mdDescription - The description of the medical devices that should be used to create the MDIB.
    
    mdibLock - The Lock that should be used for all locking operations on the MDIB.
  - createWithExistingLock
```
void createWithExistingLock(MDDescription mdDescription,
                            MDState initialMDState,
                            ReadWriteLock mdibLock)
```
    Create a MDIB using the provided description and the initial state and uses the provided lock for all read or write access to the MDIB.
    
    Parameters:
    
    mdDescription - the md description
    
    initialMDState - the initial md state
    
    mdibLock - the mdib lock
  - getManager
```
MedicalDeviceInformationBaseManager getManager()
```
    Return the Manager that should be used for all direct modifications to the MDIB.
    
    Returns:
    
    Manager that should be used for all direct modifications to the MDIB.
  - getMdibLock
```
ReadWriteLock getMdibLock()
```
    Returns the Lock that should be used for locking the MDIB for Read/Write Operations.
    
    Returns:
    
    Lock that should be used for locking the MDIB for Read/Write Operations.
  - getDeviceDescriptions
```
MDDescription getDeviceDescriptions()
```
    Returns the current descriptions of the medical devices contained in the MDIB. Caveat: The MDDescription is the original object from the MDIB and not a copy. The MDIB Lock Should be used for any read/write operations.
    
    Returns:
    
    current descriptions of the medical devices contained in the MDIB.
  - getDeviceStates
```
MDState getDeviceStates()
```
    Returns the current states of the medical devices contained in the MDIB. Caveat: The MDStates is the original object from the MDIB and not a copy. The MDIB Lock Should be used for any read/write operations.
    
    Returns:
    
    Current states of the medical devices contained in the MDIB.
  - getMetricDescriptors
```
Collection<? extends MetricDescriptor> getMetricDescriptors(Collection<String> handles)
```
    Returns the current descriptors for the metrics that are specified with the handles collection. If no handle is provided all metrics in the MDIB should be returned. If a Handle of a non-metric object (e.g. channel) is provided than all metric that are associated with that object should be returned. If a Handle of a state object (e.g. metric state) is provided all metric that are associated with that object should be returned.
    
    Parameters:
    
    handles - Collection of handles that specify which metric descriptions should be returned.
    
    Returns:
    
    Collection of descriptors of metrics.
  - getMetricStates
```
Collection<? extends AbstractMetricState> getMetricStates(Collection<String> handles)
```
    Returns the current states for the metrics that are specified with the handles collection. If no handle is provided all metrics in the MDIB should be returned. If a Handle of a non-metric object (e.g. channel) is provided than all metric that are associated with that object should be returned. If a Handle of a descriptor object (e.g. metric descriptor) is provided all metric that are associated with that object should be returned.
    
    Parameters:
    
    handles - Collection of handles that specify which metric states should be returned.
    
    Returns:
    
    Collection of states of metrics.
  - getOperationDescriptor
```
OperationDescriptor getOperationDescriptor(String operationHandle)
```
    Returns the current description for the operations that is specified with the handle. If no handle is provided NULL will be returned. If a Handle of a state object (e.g. metric state) is provided the operation description that is associated with that object should be returned.
    
    Parameters:
    
    operationHandle - Handle that specify which operation description should be returned.
    
    Returns:
    
    Description of the specified operation.
  - getAlertSystemDescriptions
```
Collection<? extends AlertSystemDescriptor> getAlertSystemDescriptions(Collection<String> handles)
```
    Returns the current descriptions for the alert systems that are specified with the handles collection. If no handle is provided all alert system descriptions in the MDIB should be returned. If a Handle of a state object (e.g. channel state) is provided all alert system descriptions that are associated with that object should be returned.
    
    Parameters:
    
    handles - Collection of handles that specify which alert system descriptions should be returned.
    
    Returns:
    
    Collection of alert system descriptions.
  - getAlertSystemDescriptor
```
AlertSystemDescriptor getAlertSystemDescriptor(String handle)
```
    Returns the current description for the alert system that is specified with the handle. If no handle is provided NULL will be returned. If a Handle of a state object (e.g. alert system state) is provided the alert system description that is associated with that object should be returned.
    
    Parameters:
    
    handle - Handle that specify which alert system description should be returned.
    
    Returns:
    
    Description of the specified alert system.
  - getAlertConditionDescriptor
```
AlertConditionDescriptor getAlertConditionDescriptor(String handle)
```
  - getAlertSignalDescriptor
```
AlertSignalDescriptor getAlertSignalDescriptor(String handle)
```
  - getAlertStates
```
Collection<? extends AbstractAlertState> getAlertStates(Collection<String> handles)
```
  - getAlertDescriptors
```
Collection<? extends AbstractAlertDescriptor> getAlertDescriptors(Collection<String> handles)
```
  - getMDSDescriptions
```
Collection<? extends MDSDescriptor> getMDSDescriptions(Collection<String> handles,
                                                       boolean onlyNonComposite)
```
  - getMDSStates
```
Collection<? extends MDSState> getMDSStates(Collection<String> handles,
                                            boolean onlyNonComposite)
```
  - getMDSDescriptionHandleForOperation
```
String getMDSDescriptionHandleForOperation(String ophandle)
```
  - getMDSForDescriptor
```
MDSDescriptor getMDSForDescriptor(String handle)
```
  - getHandle
```
String getHandle(Object o)
```
  - getOperationForOperationTarget
```
Collection<? extends OperationDescriptor> getOperationForOperationTarget(String operationTargetHandle)
```
  - getState
```
State getState(String stateHandle)
```
  - getDescriptor
```
Descriptor getDescriptor(String referencedDescriptor)
```
  - getAllDescriptors
```
Collection<Descriptor> getAllDescriptors()
```
  - getContainmentTreeEntry
```
ContainmentTreeEntry getContainmentTreeEntry(String referencedDescriptor)
```
  - getContainmentTree
```
ContainmentTree getContainmentTree(String referencedDescriptor)
```
  - getIdentifiableContextState
```
<T extends AbstractContextState> Collection<T> getIdentifiableContextState(List<String> handles,
                                                                           Class<T> contentClass)
```
  - getContextAssociationStateValues
```
Collection<? extends ContextAssociationStateValue> getContextAssociationStateValues(List<String> handles)
```
  - getMdibStateVersion
```
BigInteger getMdibStateVersion()
```

Interface MedicalDeviceInformationBase

Method Summary

Method Detail

create

create

createWithExistingLock

createWithExistingLock

getManager

getMdibLock

getDeviceDescriptions

getDeviceStates

getMetricDescriptors

getMetricStates

getOperationDescriptor

getAlertSystemDescriptions

getAlertSystemDescriptor

getAlertConditionDescriptor

getAlertSignalDescriptor

getAlertStates

getAlertDescriptors

getMDSDescriptions

getMDSStates

getMDSDescriptionHandleForOperation

getMDSForDescriptor

getHandle

getOperationForOperationTarget

getState

getDescriptor

getAllDescriptors

getContainmentTreeEntry

getContainmentTree

getIdentifiableContextState

getContextAssociationStateValues

getMdibStateVersion