org.sandev.TaskHeap.structs
Class DataManagementStruct

java.lang.Object
  extended by org.sandev.TaskHeap.structs.DataManagementStruct
Direct Known Subclasses:
DataManagement

public class DataManagementStruct
extends java.lang.Object

A singleton instance describing the data management functions available for a heap. This exists so that the field descriptions can be used to describe the function to be performed, with the corresponding button displayed as the value. The purpose is to provide a veritical listing of available global functions with descriptive information. Functions that are not immediately identifiable by button name within a current form context belong here.

This is a singleton class created in the initial data. The corresponding buttons are defined in the SandUI.

This message is persistent.
summary fields: exportData publishHeap dumpTasks
This message has the following verb forms: update query collection
declared printname: Data Management
help text: Data management functions for your heap.

Field Summary
protected  java.lang.String confirmChildren
          Verify that each heap element referencing a parent is listed as a child of that parent.
protected  java.lang.String confirmParents
          Verify that each referenced child has the correct parent reference.
protected  java.lang.String dumpTasks
          Dump the task definitions to CSV.
protected  java.lang.String exportData
          Export the current heap data to XML.
protected  java.lang.String importHeap
          Read the exported data for the given heap back into the current heap.
protected  java.lang.String publishHeap
          Publish the current heap data as HTML.
protected  java.lang.String tutorial
          Create a new tutorial heap showing how to use TaskHeap.
 
Constructor Summary
DataManagementStruct()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

publishHeap

protected java.lang.String publishHeap
Publish the current heap data as HTML.

Length in characters, normal: 40 max: 60
declared printname: Publish Heap
help text: Publish the current heap as an HTML file for reference.

exportData

protected java.lang.String exportData
Export the current heap data to XML.

Length in characters, normal: 40 max: 60
declared printname: Export Data
help text: Export the current heap data to an XML file for backup and external program analysis support purposes.

dumpTasks

protected java.lang.String dumpTasks
Dump the task definitions to CSV.

Length in characters, normal: 40 max: 60
declared printname: Dump Tasks
help text: Dump the current task definitions to CSV for import into a spreadsheet.

tutorial

protected java.lang.String tutorial
Create a new tutorial heap showing how to use TaskHeap.

Length in characters, normal: 40 max: 60
declared printname: Reset Tutorial Heap
help text: Create a new tutorial heap to learn about how TaskHeap works. The tutorial shows you what you need to know to be immediately effective using TaskHeap.

importHeap

protected java.lang.String importHeap
Read the exported data for the given heap back into the current heap.

Length in characters, normal: 40 max: 60
declared printname: Import Heap
help text: Site administrator action to read the exported data for a given heap back into the current heap.

confirmParents

protected java.lang.String confirmParents
Verify that each referenced child has the correct parent reference.

Length in characters, normal: 40 max: 60
declared printname: Confirm Parents
help text: Verify that each referenced child has the correct parent reference.

confirmChildren

protected java.lang.String confirmChildren
Verify that each heap element referencing a parent is listed as a child of that parent.

Length in characters, normal: 40 max: 60
declared printname: Confirm Children
help text: Verify that each heap element referencing a parent is listed as a child of that parent.
Constructor Detail

DataManagementStruct

public DataManagementStruct()