Object that contains the information of a single task.
More...
Object that contains the information of a single task.
See also WorklistTool::getList() to obtain an array of this object.
◆ get()
string get |
( |
string |
field | ) |
|
Gets the value of a given field.
- Parameters
-
- Returns
- The field's value as string
- Deprecated:
◆ getCategory()
Gets the task's category.
- Returns
- The task's category
◆ getCreatedDate()
string getCreatedDate |
( |
| ) |
|
Gets the date the task was created.
- Returns
- The date the task was created
◆ getDBPatientID()
string getDBPatientID |
( |
| ) |
|
Gets the Database Patient ID associated with the task.
- Returns
- The Database Patient ID associated with the task
- Deprecated:
◆ getFormName()
Gets the associated form name.
- Returns
- The associated form name
◆ getPatientID()
Gets the Patient ID associated with the task.
- Returns
- The Patient ID associated with the task
◆ getPatientsName()
string getPatientsName |
( |
| ) |
|
Gets the patient's name.
- Returns
- The patient's name
◆ getPrevTaskID()
Gets the previous visit's task ID.
- Note
- Will return the actual task ID if the workflow tool is supported on the IPACs, otherwise it will return nothing
- Deprecated:
◆ getPriority()
Gets the priority value.
- Returns
- The priority value
◆ getProcessID()
Gets the task's process instance id.
- Returns
- The task's process instance id
◆ getProcessName()
string getProcessName |
( |
| ) |
|
Gets the task's process instance name.
- Returns
- The task's process instance name
◆ getProjectID()
Gets the project id.
- Returns
- The project id
◆ getProjectPath()
string getProjectPath |
( |
| ) |
|
Gets the project path.
- Returns
- The project path
◆ getProperty() [1/2]
Variant getProperty |
( |
Array< string > |
propertyChain | ) |
|
Gets a property of the task that is a property of other properties.
- Parameters
-
Array<string> | propertyChain the list of properties – ex. {"foo", "bar"} would yield task["foo"]["bar"] |
- Returns
- The value associated with the given keys for the task
◆ getProperty() [2/2]
Variant getProperty |
( |
string |
propertyName | ) |
|
Gets a property of the task.
- Parameters
-
propertyName | The name of the property to be looked up |
- Returns
- The value associated with propertyName for the task
◆ getScanID()
Gets the scan ID that the task is attached to.
- Returns
- The scan ID that the task is attached to
◆ getSeriesIDs()
Array<string> getSeriesIDs |
( |
string |
filterStudy = "" | ) |
|
Gets the SeriesInstanceUIDs associated with the task.
- Parameters
-
filterStudy | The StudyInstanceUID or StudyID filter. If none is provided, all the series from all studies will be returned. |
- Returns
- The SeriesInstanceUIDs associated with the task
◆ getSeriesUIDs()
Array<string> getSeriesUIDs |
( |
string |
filterStudy = "" | ) |
|
Gets the SeriesInstanceUIDs associated with the task.
- Parameters
-
filterStudy | The StudyInstanceUID or StudyID filter. If none is provided, all the series from all studies will be returned. |
- Returns
- The SeriesInstanceUIDs associated with the task
◆ getSiteName()
Gets the task's site name.
- Returns
- The task's site name
◆ getStatus()
Gets task's status.
- Deprecated:
- No longer necessary with iPACS 2021
◆ getStudyIDs()
Array<string> getStudyIDs |
( |
| ) |
|
Gets the iPACS StudyIDs associated with the task.
- Returns
- The StudyIDs associated with the task
◆ getStudyUIDs()
Array<string> getStudyUIDs |
( |
| ) |
|
Gets the StudyInstanceUIDs associated with the task.
- Returns
- The StudyInstanceUIDs associated with the task
◆ getTaskID()
Gets the task ID.
- Returns
- The task ID
◆ getTaskType()
Gets the task type.
- Returns
- The task type
◆ getTimepoint()
Gets the task's timepoint name.
- Returns
- The task's timepoint name
◆ isBlocked()
Gets whether the task is blocked.
- Returns
- True if the task is blocked, false otherwise
◆ isEditable()
Gets task's editable status.
- Note
- An editable task but whose edition is allowed and the previous existing data will be loaded in the form
- Deprecated: