*** This interface is subject to change. ***

com.sas.iquery.metadata.business
Interface Prompt

All Superinterfaces:

Base, BusinessItem, BusinessModelObject, BusinessModelResource, BusinessModelResourceReferencer, java.lang.Cloneable, java.util.EventListener, ExpressionInterface, ExtendedAttributes, LocalizableModelObject, LocalizableNamedObjectInterface, com.sas.util.LocalizableToStringInterface, ModelItem, ModelItemWithIdentity, NamedObjectInterface, PropertyChangeListenee, java.beans.PropertyChangeListener, UsabilityInterface

public interface Prompt
extends BusinessItem, ExpressionInterface, ModelItemWithIdentity, LocalizableModelObject

Enables you to specify portions of a business query at the time a query is run. The modeling for much of the Prompt object is provided by the AttributeDescriptorInterface supplied by the Entities model.

Prompts can be used within data item and filter expressions. For example, one can filter on a prompted value by using the SimpleConditionalExpression_Comparison class to model the comparison expression X < prompt and using that expression as a filter's expression.

Field Summary

Fields inherited from interface com.sas.iquery.metadata.business.ModelItemWithIdentity

EVENT_DESCRIPTION_CHANGED, EVENT_HIDDEN_CHANGED, EVENT_ID_CHANGED, EVENT_LABEL_CHANGED

Fields inherited from interface com.sas.iquery.metadata.business.ModelItem

EVENT_OBJECT_PROPERTY_CHANGED

Fields inherited from interface com.sas.iquery.metadata.business.Base

EVENT_OBJECT_DEFINITION_CHANGED

Fields inherited from interface com.sas.iquery.metadata.business.LocalizableModelObject

EVENT_LOCALIZABLE_DESCRIPTIONS_CHANGED, EVENT_LOCALIZABLE_LABELS_CHANGED

Method Summary

com.sas.entities.AttributeDescriptorInterface	getAttributeDescriptor() Deprecated. Use getPromptDefintion
com.sas.prompts.definitions.PromptDefinitionInterface	getPromptDefinition() Returns the definition of this Prompt.
void	setAttributeDescriptor(com.sas.entities.AttributeDescriptorInterface descriptor) Deprecated. Use setPromptDefintion
void	setPromptDefinition(com.sas.prompts.definitions.PromptDefinitionInterface definition) Sets the prompt definition for this object.

Methods inherited from interface com.sas.iquery.metadata.business.BusinessModelObject

getBusinessModel, isContainedInBusinessModel, isIDOK, isReadOnly

Methods inherited from interface com.sas.iquery.metadata.business.ModelItemWithIdentity

getID, getIdentityString, getIntraModelID, isHidden, isUnresolved, setDescription, setIntraModelID, setIsHidden, setLabel

Methods inherited from interface com.sas.iquery.metadata.PropertyChangeListenee

addListener, getListeners, removeListener

Methods inherited from interface com.sas.iquery.metadata.business.UsabilityInterface

getReasonsUnusable, isUsableInQuery

Methods inherited from interface com.sas.iquery.metadata.business.BusinessModelResource

isUnresolved

Methods inherited from interface com.sas.iquery.metadata.NamedObjectInterface

getDescription, getLabel

Methods inherited from interface com.sas.iquery.metadata.business.BusinessModelResourceReferencer

getResources

Methods inherited from interface com.sas.iquery.metadata.business.ExtendedAttributes

getExtendedAttributes, setExtendedAttributes

Methods inherited from interface com.sas.iquery.metadata.expr.ExpressionInterface

getExpressionType

Methods inherited from interface com.sas.iquery.metadata.business.LocalizableModelObject

getLocalizableProperties, getLocalizationPrependKey, setDescription, setDescriptions, setLabel, setLabels, setLocalizableProperties

Methods inherited from interface com.sas.iquery.metadata.LocalizableNamedObjectInterface

getDescription, getDescriptions, getLabel, getLabels

Method Detail

*** This method is subject to change. ***

getAttributeDescriptor

com.sas.entities.AttributeDescriptorInterface getAttributeDescriptor()

Deprecated. Use getPromptDefintion

Returns the attribute descriptor containing the prompt definition for this object.

Returns:

AttributeDescriptorInterface the attribute descriptor containing the prompt definition for this object or null.

*** This method is subject to change. ***

setAttributeDescriptor

void setAttributeDescriptor(com.sas.entities.AttributeDescriptorInterface descriptor)

Deprecated. Use setPromptDefintion

Sets the attribute descriptor containing the prompt definition for this object.

Parameters:

descriptor - the attribute descriptor to use.

*** This method is subject to change. ***

getPromptDefinition

com.sas.prompts.definitions.PromptDefinitionInterface getPromptDefinition()

Returns the definition of this Prompt.

Returns:

a PromptDefinitionInterface or null. If null is returned the prompt is unusable in a query.

*** This method is subject to change. ***

setPromptDefinition

void setPromptDefinition(com.sas.prompts.definitions.PromptDefinitionInterface definition)

Sets the prompt definition for this object.

Property change events signaled:

• EVENT_PROMPT_DEFINITION_CHANGED

Parameters:

definition - - the prompt definition to be used.

*** This interface is subject to change. ***