oracle.cabo.ui.beans.message
Interface MessageBean

All Superinterfaces:

MutableUINode, UINode

All Known Implementing Classes:

InlineMessageBean, MessageCheckBoxBean, MessageDateFieldBean, MessageFileUploadBean, MessageListBean, MessageLovFieldBean, MessageLovInputBean, MessageRadioButtonBean, MessageStyledTextBean, MessageTextInputBean, MessageRadioGroupBean, MessageChoiceBean

public interface MessageBean

extends MutableUINode

Interface implemented by all components that support messaging.

Method Summary

java.lang.String	getLongDescURL() Gets an URL to a page with more information about the message.
java.lang.String	getMessage() Gets the error, warning, or informational text.
java.lang.String	getMessageType() Gets the type of the message; acceptable values are "error", "warning", "info", and "none".
java.lang.String	getPrompt() Gets the prompt of the bean.
java.lang.String	getRequired() Gets whether the associated control requires user input.
java.lang.String	getTargetFrame() Gets the target frame for the URL, if any.
java.lang.String	getTip() Gets the tip text associated with the control
void	setLongDescURL(java.lang.String longDescURL) Sets an URL to a page with more information about the message.
void	setLongDescURLBinding(java.lang.Object selectKey) Binds the an URL to a page with more information about the message.
void	setLongDescURLBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the an URL to a page with more information about the message.
void	setMessage(java.lang.String message) Sets the error, warning, or informational text.
void	setMessageBinding(java.lang.Object selectKey) Binds the the error, warning, or informational text.
void	setMessageBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the the error, warning, or informational text.
void	setMessageType(java.lang.String messageType) Sets the type of the message; acceptable values are "error", "warning", "info", and "none".
void	setMessageTypeBinding(java.lang.Object selectKey) Binds the the type of the message; acceptable values are "error", "warning", "info", and "none".
void	setMessageTypeBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the the type of the message; acceptable values are "error", "warning", "info", and "none".
void	setPrompt(java.lang.String prompt) Sets the prompt of the bean.
void	setRequired(java.lang.String required) Sets whether the associated control requires user input.
void	setTargetFrame(java.lang.String targetFrame) Sets the target frame for the URL, if any.
void	setTip(java.lang.String tip) Sets the tip text associated with the control

Methods inherited from interface oracle.cabo.ui.MutableUINode

addIndexedChild, addIndexedChild, clearIndexedChildren, getAttributeValue, removeIndexedChild, replaceIndexedChild, setAttributeValue, setAttributeValue, setAttributeValue, setID, setNamedChild, setNodeID

Methods inherited from interface oracle.cabo.ui.UINode

getAttributeNames, getAttributeValue, getAttributeValue, getChildNames, getChildNames, getID, getIndexedChild, getIndexedChild, getIndexedChildCount, getIndexedChildCount, getLocalName, getNamedChild, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getRawAttributeValue, render, render

Method Detail

getPrompt

public java.lang.String getPrompt()

Gets the prompt of the bean.

setPrompt

public void setPrompt(java.lang.String prompt)

Sets the prompt of the bean.

getTip

public java.lang.String getTip()

Gets the tip text associated with the control

setTip

public void setTip(java.lang.String tip)

Sets the tip text associated with the control

getMessageType

public java.lang.String getMessageType()

Gets the type of the message; acceptable values are "error", "warning", "info", and "none". Defaults to "none".

setMessageType

public void setMessageType(java.lang.String messageType)

Sets the type of the message; acceptable values are "error", "warning", "info", and "none". Defaults to "none".

setMessageTypeBinding

public void setMessageTypeBinding(java.lang.Object selectKey)

Binds the the type of the message; acceptable values are "error", "warning", "info", and "none". Defaults to "none".

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setMessageTypeBinding

public void setMessageTypeBinding(java.lang.String dataNamespace,
                                  java.lang.String dataName,
                                  java.lang.Object selectKey)

Binds the the type of the message; acceptable values are "error", "warning", "info", and "none". Defaults to "none".

Parameters:

dataNamespace - the namespace to be passed to RenderingContext.getDataObject()

dataName - the name to be passed to RenderingContext.getDataObject()

selectKey - the key to be passed to selectValue() on the DataObject.

getMessage

public java.lang.String getMessage()

Gets the error, warning, or informational text.

setMessage

public void setMessage(java.lang.String message)

Sets the error, warning, or informational text.

setMessageBinding

public void setMessageBinding(java.lang.Object selectKey)

Binds the the error, warning, or informational text.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setMessageBinding

public void setMessageBinding(java.lang.String dataNamespace,
                              java.lang.String dataName,
                              java.lang.Object selectKey)

Binds the the error, warning, or informational text.

Parameters:

dataNamespace - the namespace to be passed to RenderingContext.getDataObject()

dataName - the name to be passed to RenderingContext.getDataObject()

selectKey - the key to be passed to selectValue() on the DataObject.

getLongDescURL

public java.lang.String getLongDescURL()

Gets an URL to a page with more information about the message.

setLongDescURL

public void setLongDescURL(java.lang.String longDescURL)

Sets an URL to a page with more information about the message.

setLongDescURLBinding

public void setLongDescURLBinding(java.lang.Object selectKey)

Binds the an URL to a page with more information about the message.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setLongDescURLBinding

public void setLongDescURLBinding(java.lang.String dataNamespace,
                                  java.lang.String dataName,
                                  java.lang.Object selectKey)

Binds the an URL to a page with more information about the message.

Parameters:

dataNamespace - the namespace to be passed to RenderingContext.getDataObject()

dataName - the name to be passed to RenderingContext.getDataObject()

selectKey - the key to be passed to selectValue() on the DataObject.

getTargetFrame

public java.lang.String getTargetFrame()

Gets the target frame for the URL, if any.

setTargetFrame

public void setTargetFrame(java.lang.String targetFrame)

Sets the target frame for the URL, if any.

getRequired

public java.lang.String getRequired()

Gets whether the associated control requires user input. Three values are allowed: "yes", "no", and "default". A visual indication will only be displayed if the value is set to "yes".

setRequired

public void setRequired(java.lang.String required)

Sets whether the associated control requires user input. Three values are allowed: "yes", "no", and "default". A visual indication will only be displayed if the value is set to "yes".