com.sage.accpac.sm
Class ReportParameter

java.lang.Object
  com.sage.accpac.sm.ReportParameter

@NotThreadSafe
public class ReportParameter
extends java.lang.Object

An object for the info of Report Parameters

Nested Class Summary

static class

ReportParameter.ReportParamType Types of report parameters

Constructor Summary

ReportParameter(java.lang.String name, byte[] description, int type, ReportParamPresentItem[] presentItems)
Construct without parameter value

ReportParameter(java.lang.String name, byte[] description, int type, ReportParamPresentItem[] presentItems, java.lang.String value)
Construct with parameter value

Method Summary

java.lang.String	getDescription() Get the description of the report parameter
java.lang.String	getName() Get the name of the report parameter
ReportParamPresentItem[]	getPresentItems() Get the presentation items of the report parameter
ReportParameter.ReportParamType	getType() Get the type of the report parameter
java.lang.String	getValue() Get the value of the report parameter
void	setValue(java.lang.String value) Set the value of the report parameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportParameter

public ReportParameter(java.lang.String name,
                       byte[] description,
                       int type,
                       ReportParamPresentItem[] presentItems)

Construct without parameter value

Parameters:

name - the name of the report parameter

description - the description of the report parameter

type - the type of the report parameter

presentItems - the array of ReportParamPresentItem of the report parameter

ReportParameter

public ReportParameter(java.lang.String name,
                       byte[] description,
                       int type,
                       ReportParamPresentItem[] presentItems,
                       java.lang.String value)

Construct with parameter value

Parameters:

name - the name of the report parameter

description - the description of the report parameter

type - the type of the report parameter

presentItems - the array of ReportParamPresentItem of the report parameter

value - the value of the report parameter

Method Detail

getName

public java.lang.String getName()

Get the name of the report parameter

Returns:

the name of the report parameter

getDescription

public java.lang.String getDescription()

Get the description of the report parameter

Returns:

the description of the report parameter

getType

public ReportParameter.ReportParamType getType()

Get the type of the report parameter

Returns:

the type of the report parameter

getPresentItems

public ReportParamPresentItem[] getPresentItems()

Get the presentation items of the report parameter

Returns:

an array of ReportParamPresentItem of the report parameter

getValue

public java.lang.String getValue()

Get the value of the report parameter

Returns:

the value of the report parameter

setValue

public void setValue(java.lang.String value)

Set the value of the report parameter

Parameters:

value - the value of the report parameter