WorklistQuery

java.lang.Object
- be.uclouvain.orthanc.WorklistQuery

public class WorklistQuery
extends java.lang.Object

DICOM C-FIND worklist query

Constructor Summary

Constructors
Modifier Constructor Description

protected WorklistQuery(long self)
Construct a Java object wrapping a C object that is managed by Orthanc.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected long`	`getSelf()`	Return the C object that is associated with this Java wrapper.
`byte[]`	`worklistGetDicomQuery()`	Retrieve the worklist query as a DICOM file.
`int`	`worklistIsMatch(byte[] dicom)`	Test whether a worklist matches the query.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WorklistQuery
```
protected WorklistQuery(long self)
```
    Construct a Java object wrapping a C object that is managed by Orthanc.
    
    Parameters:
    
    self - Pointer to the C object.
- Method Detail
  - getSelf
```
protected long getSelf()
```
    Return the C object that is associated with this Java wrapper.
    
    Returns:
    
    Pointer to the C object.
  - worklistIsMatch
```
public int worklistIsMatch(byte[] dicom)
```
    Test whether a worklist matches the query. This function checks whether one worklist (encoded as a DICOM file) matches the C-Find SCP query against modality worklists. This function must be called before adding the worklist as an answer through OrthancPluginWorklistAddAnswer().
    
    Parameters:
    
    dicom - The worklist to answer, encoded as a DICOM file.
    
    Returns:
    
    1 if the worklist matches the query, 0 otherwise.
  - worklistGetDicomQuery
```
public byte[] worklistGetDicomQuery()
```
    Retrieve the worklist query as a DICOM file. This function retrieves the DICOM file that underlies a C-Find SCP query against modality worklists.
    
    Returns:
    
    The resulting memory buffer.