MSIConstantPrompt Class Reference

#import <MSIConstantPrompt.h>

Inheritance diagram for MSIConstantPrompt:

Instance Methods
(id)	- copyWithZone:
(MSIPromptAnswer *)	- newAnswerWithType:
(MSIPromptAnswer *)	- answer
(void)	- setAnswer:
(BOOL)	- hasAnswer
(NSNumber *)	- valueAsNumber
(NSNumber *)	- minAsNumber
(NSNumber *)	- maxAsNumber
(NSDate *)	- valueAsDate
(NSDate *)	- minAsDate
(NSDate *)	- maxAsDate
Instance Methods inherited from MSIPrompt
(BOOL)	- validateAnswer
(void)	- rebuildFormatter
(NSInteger)	- validateMinMax:
(MSTRFormatter *)	- formatter
(void)	- addLocationAttributes:
(void)	- buildAnswerXml:
(MSTRError *)	- beforeBuildAnswerXml
(void)	- buildTypeSpecificAnswerXml:
(id< MSTRHandler >)	- getAnswerHandler
(void)	- setErrorWithMessage:
Instance Methods inherited from MSIObjectInfo
(id)	- initWithType:
(id)	- initWithType:subType:
(NSComparisonResult)	- compareElementName:
(NSComparisonResult)	- compareElementID:
(void)	- handleXml:attributes:support:
(id< MSTRHandler >)	- getXmlHandler
(void)	- handleXmlAttributes:attributes:
(void)	- loadFromXML:attributes:
(NSString *)	- getXml
(void)	- buildXml:
(void)	- buildXml:tagName:
(void)	- buildTypeSpecificXml:
(id)	- initWithContents:anID:aDesc:aType:aSubtype:anAbbrev:isShortcut:iconPath:
(id)	- initWithContents:namedID:aDesc:aType:aSubtype:anAbbrev:isShortcut:iconPath:
Instance Methods inherited from <MSTRHandler>
(void)	- doStartElement:namespaceURI:attributes:level:support:
(void)	- doEndElement:namespaceURI:level:support:
Instance Methods inherited from <MIIDynamicTableDataItem>
(MIDisplayStyle)	- getStyle
(NSString *)	- getTitle
(NSString *)	- getDetailedText
(NSString *)	- getImageName
(void)	- setDynamicTableDataItemDelegate:
(id< MIIDynamicTableDataItemDelegate >)	- getDynamicTableDataItemDelegate
(MetricExpression *)	- getMetricExpression
(double)	- getMetricValueMin
(double)	- getMetricValueMax
(double)	- getMetricValueCount
(BOOL)	- isMetricValueSupported
(BOOL)	- isSelectorModeInclude
(NSArray *)	- getDisplayStylesGroup
(void)	- setDisplayStylesGroup:
(void)	- setOrderWithIndex:
(Commander *)	- getCommander
(BOOL)	- isExecuteImmediately
(void)	- execute
(void)	- prehandleMetricSelection:
(void)	- handleMetricSelection:
(void)	- prehandleSetPropertyWithName:propertySetName:propertyValue:
(void)	- handleSetPropertyWithName:propertySetName:propertyValue:
(void)	- prehandleToggleIncludeMetric:
(void)	- handleToggleIncludeMetric:
(void)	- prehandleDelete
(void)	- handleDelete

Protected Attributes
DataTypes	mAnswerDataType
Protected Attributes inherited from MSIPrompt
PromptTypes	promptType
NSString *	title
NSString *	min
NSString *	max
NSString *	meaning
BOOL	required
NSMutableDictionary *	properties
BOOL	handlingAnswer
MSTRFormatter *	formatter
BOOL	hasAnswer
MSIPromptAnswer *	mAnswer
BOOL	mIsHidden
BOOL	mIsClosed

Properties
DataTypes	answerDataType
Properties inherited from MSIPrompt
MSIReportDisplayInfo *	document
MSIPromptAnswer *	answer
BOOL	hidden
BOOL	closed
Properties inherited from MSIObjectInfo
NSString *	objectID
NSInteger	namedID
NSString *	name
NSString *	displayName
ObjectTypes	type
NSString *	sta
ObjectSubTypes	subType
NSInteger	accessGranted
NSInteger	viewMedia
NSInteger	availableViewMedia
NSString *	desc
NSString *	abbreviation
NSString *	iconPath
NSString *	owner
BOOL	isShortcut
NSString *	externalPath
NSInteger	externalObjectType
NSDate *	creationDate
NSDate *	modificationDate
int	binaryStatus
MSIObjectInfo *	parentFolder
NSString *	containerId
NSString *	containerType

Additional Inherited Members
Class Methods inherited from MSIObjectInfo
(MSIObjectInfo *)	+ newObject:
(ObjectSubTypes)	+ subTypeFromType:

Detailed Description

Also known as a Value prompt, MSIConstantPrompt covers Date & Time, various Numeric, Text and Big Decimal.

Method Documentation

answer()

- (MSIPromptAnswer*) answer

The answer should be a subclass of ConstantPromptAnswer, for Numeric, String, DateTime and BigDecimal.

See also

NumericPromptAnswer, MSIStringPromptAnswer, MSIDateTimePromptAnswer, MSIBigDecimalPromptAnswer

copyWithZone:()

- (id) copyWithZone:

(NSZone *)

zone

hasAnswer()

- (BOOL) hasAnswer

maxAsDate()

- (NSDate*) maxAsDate

maxAsNumber()

- (NSNumber*) maxAsNumber

minAsDate()

- (NSDate*) minAsDate

minAsNumber()

- (NSNumber*) minAsNumber

newAnswerWithType:()

- (MSIPromptAnswer*) newAnswerWithType:

(DataTypes)

dataType

Creates a ConstantPromptAnswer according to the given data type, i.e. for Numeric, String, DateTime and BigDecimal.

Parameters

dataType

One of DataTypeBigDecimal, MSIDateTimePromptAnswer, DataTypeNumeric, DataTypeFloat, DataTypeReal, DataTypeDouble, DataTypeDecimal, DataTypeChar

Returns

a subclass of ConstantPromptAnswer, not having an initial value.

See also

DataTypes, MSINumericPromptAnswer, MSIStringPromptAnswer, MSIDateTimePromptAnswer, MSIBigDecimalPromptAnswer

setAnswer:()

- (void) setAnswer:

(MSIPromptAnswer *)

newAnswer

The answer should be a subclass of ConstantPromptAnswer, for Numeric, String, DateTime and BigDecimal. Setting this does not trigger any responses, such as re-running a report or sending to the server.

See also

NumericPromptAnswer, MSIStringPromptAnswer, MSIDateTimePromptAnswer, MSIBigDecimalPromptAnswer

valueAsDate()

- (NSDate*) valueAsDate

valueAsNumber()

- (NSNumber*) valueAsNumber

Member Data Documentation

mAnswerDataType

- (DataTypes) mAnswerDataType

protected

Property Documentation

answerDataType

- (DataTypes) answerDataType

readwriteatomic