com.ptc.core.query.report.command.common
Class AbstractReportQueryCommand

java.lang.Object
  extended by com.ptc.core.command.common.bean.AbstractCommand
      extended by com.ptc.core.command.common.bean.AbstractServerCommand
          extended by com.ptc.core.command.common.bean.repository.AbstractRepositoryCommand
              extended by com.ptc.core.query.command.common.AbstractQueryCommand
                  extended by com.ptc.core.query.report.command.common.AbstractReportQueryCommand
All Implemented Interfaces:
PageRequest, RepositoryCommand, com.ptc.core.command.common.Command, com.ptc.core.command.common.ServerCommand, Externalizable, Serializable
Direct Known Subclasses:
BasicReportQueryCommand, PersistedReportQueryCommand

public abstract class AbstractReportQueryCommand
extends AbstractQueryCommand
implements Externalizable

This class provies a query implementation based on a QML source. The results, criteria, and sort specifications are derived from the QML. The default PageMode is also set so that no paging is performed.

Supported API: true

Extendable: false

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.ptc.core.command.common.bean.repository.RepositoryCommand
PAGE_MODE, RESULT_CONTAINER, RESULT_SESSION, SORT
 
Fields inherited from interface com.ptc.core.command.common.bean.repository.PageRequest
COUNT, OFFSET
 
Method Summary
 Hashtable getArguments()
          Gets the value of the attribute: arguments; The runtime arguments of the report query.
 TableModel getTableModel()
          Gets the value of the attribute: tableModel; This method returns a relational TableModel view of the results.
 boolean isGenerateTypeInstances()
          Gets the value of the attribute: generateTypeInstances; Used to determine whether or not TypeInstances should be generated.
 void setArguments(Hashtable a_Arguments)
          Sets the value of the attribute: arguments; The runtime arguments of the report query.
 void setGenerateTypeInstances(boolean a_GenerateTypeInstances)
          Sets the value of the attribute: generateTypeInstances; Used to determine whether or not TypeInstances should be generated.
 
Methods inherited from class com.ptc.core.query.command.common.AbstractQueryCommand
getCriteriaAugmentor, setCriteriaAugmentor
 
Methods inherited from class com.ptc.core.command.common.bean.repository.AbstractRepositoryCommand
getCount, getOffset, getResultContainer, getResultSession, setCount, setOffset, setSort
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getTableModel

public TableModel getTableModel()
Gets the value of the attribute: tableModel; This method returns a relational TableModel view of the results.

Supported API: true

Returns:
TableModel

getArguments

public Hashtable getArguments()
Gets the value of the attribute: arguments; The runtime arguments of the report query. The values are mapped to query bind parameters as specified in the QML.

Supported API: true

Returns:
Hashtable

setArguments

public void setArguments(Hashtable a_Arguments)
                  throws WTPropertyVetoException
Sets the value of the attribute: arguments; The runtime arguments of the report query. The values are mapped to query bind parameters as specified in the QML.

Supported API: true

Parameters:
a_Arguments -
Throws:
WTPropertyVetoException

isGenerateTypeInstances

public boolean isGenerateTypeInstances()
Gets the value of the attribute: generateTypeInstances; Used to determine whether or not TypeInstances should be generated.

Supported API: true

Returns:
boolean

setGenerateTypeInstances

public void setGenerateTypeInstances(boolean a_GenerateTypeInstances)
                              throws WTPropertyVetoException
Sets the value of the attribute: generateTypeInstances; Used to determine whether or not TypeInstances should be generated.

Supported API: true

Parameters:
a_GenerateTypeInstances -
Throws:
WTPropertyVetoException