public interface

TaskParameterMetadata

com.microstrategy.web.tasks.TaskParameterMetadata
Known Indirect Subclasses

Class Overview

This interface provides information about a specific Task parameter. This "metadata" can be used for diagnostic and adminstrative purposes.

Summary

Public Methods
abstract String[] getArrayValue(RequestKeys requestKeys)
Returns an array of string values by parsing the parameter value.
abstract String[] getArrayValue(RequestKeys requestKeys, String delim)
Returns an array of string values by parsing the parameter value and using the specified delimiter.
abstract boolean getBooleanValue(RequestKeys requestKeys)
Returns the boolean value of a parameter.
abstract String getDefaultValue()
Get the default value associated with this parameter.
abstract Object getDefaultValueObject()
Get the default generic object associated with this parameter.
abstract String getDescription()
Returns the textual description of this Task parameter.
abstract int getIntValue(RequestKeys requestKeys)
Returns the integer value of a parameter.
abstract long getLongValue(RequestKeys requestKeys)
Returns the long value of a parameter.
abstract String getName()
Returns the name of this Task parameter.
abstract PostedFile getPostedFile(TaskRequestContext context)
Returns data file uploaded by user via a "multipart/form-data" request form.
abstract String getType()
Returns the data type of this Task parameter.
abstract String getValidator()
Returns the data type validator of this Task parameter.
abstract String getValue(RequestKeys requestKeys)
Returns the value of a parameter, given the supplied input parameters.
abstract Enumeration getValueObject(RequestKeys requestKeys)
Returns the enumeration of value objects of a parameter, given the supplied input parameters.
abstract boolean isHidden()
abstract boolean isRequired()
Whether this Task parameter is required, and must be supplied in all Task invocations.

Public Methods

public abstract String[] getArrayValue (RequestKeys requestKeys)

Returns an array of string values by parsing the parameter value. It assumes that array elements are separated (delimited) by commas.

Returns
  • An array of Strings (without delimiters included).

public abstract String[] getArrayValue (RequestKeys requestKeys, String delim)

Returns an array of string values by parsing the parameter value and using the specified delimiter.

Parameters
requestKeys A RequestKeys object that contains the input parameters.
delim The String delimiter used to separate array elements.
Returns
  • An array of Strings (without delimiters included).

public abstract boolean getBooleanValue (RequestKeys requestKeys)

Returns the boolean value of a parameter. If not specified, a parameter's default value may be used.

Parameters
requestKeys A RequestKeys object that contains the input parameters.
Returns
  • A boolean value for the parameter.
Throws
TaskRequestMalformedException If the value cannot be converted to a boolean value. This condition indicates that the caller did not make a valid Task invocation.

public abstract String getDefaultValue ()

Get the default value associated with this parameter.

Returns
  • The default value, or null, if no default value is specified.

public abstract Object getDefaultValueObject ()

Get the default generic object associated with this parameter.

Returns
  • The default value object, or null, if no default value is specified.

public abstract String getDescription ()

Returns the textual description of this Task parameter.

Returns
  • The textual description of this Task parameter.

public abstract int getIntValue (RequestKeys requestKeys)

Returns the integer value of a parameter. If not specified, a parameter's default value may be used.

Parameters
requestKeys A RequestKeys object that contains the input parameters.
Returns
  • An integer value for the parameter.
Throws
TaskRequestMalformedException If the value cannot be converted to an integer. This condition indicates that the caller did not make a valid Task invocation.

public abstract long getLongValue (RequestKeys requestKeys)

Returns the long value of a parameter. If not specified, a parameter's default value may be used.

Parameters
requestKeys A RequestKeys object that contains the input parameters.
Returns
  • A long (integer) value for the parameter.
Throws
TaskRequestMalformedException If the value cannot be converted to a long. This condition indicates that the caller did not make a valid Task invocation.

public abstract String getName ()

Returns the name of this Task parameter.

Returns
  • The name of this Task parameter.

public abstract PostedFile getPostedFile (TaskRequestContext context)

Returns data file uploaded by user via a "multipart/form-data" request form. Note that PostedFile is always returned even if the user uploaded nothing - getLength() should be checked for non-zero to indicate existence of data.

Returns
  • the data uploaded with "multipart/form-data".

public abstract String getType ()

Returns the data type of this Task parameter.

Returns
  • The data type of this Task parameter.

public abstract String getValidator ()

Returns the data type validator of this Task parameter.

Returns
  • The the data type validator of this Task parameter.

public abstract String getValue (RequestKeys requestKeys)

Returns the value of a parameter, given the supplied input parameters. If the parameter has been explicitly specified in the input parameters, it is returned. If not, and the default value is non-null, then that is returned. Otherwise, null is returned.

Parameters
requestKeys A RequestKeys object that contains the input parameters.
Returns
  • The computed value of the parameter for a specific request.

public abstract Enumeration getValueObject (RequestKeys requestKeys)

Returns the enumeration of value objects of a parameter, given the supplied input parameters. If the parameter has been explicitly specified in the input parameters, it is returned. If not, and the default value is non-null, then that is returned. Otherwise, null is returned.

Parameters
requestKeys A RequestKeys object that contains the input parameters.
Returns
  • The computed value of the parameter for a specific request.

public abstract boolean isHidden ()

public abstract boolean isRequired ()

Whether this Task parameter is required, and must be supplied in all Task invocations.

Returns
  • True, if this parameter is required; otherwise, false.