ariba.ui.aribaweb.core
Interface AWCycleable

All Superinterfaces:

AWObject

All Known Subinterfaces:

AWBindable, AWComponentDefinition.ScriptClassProvider, AWElement, AWHtmlForm

All Known Implementing Classes:

AribaAboutBox, AribaAction, AribaBanner, AribaBasicPageWrapper, AribaCommandBar, AribaCondition, AribaContactBox, AribaHelp, AribaImage, AribaLoginForm, AribaNavigationBar, AribaNotificationDialog, AribaPageContent, AribaPrintMenu, AribaResourceUrl, AribaShutdownWarning, AribaSite, AribaString, AribaToc, AWAction, AWActionCheckbox, AWActionId, AWActionUrl, AWActiveImage, AWApi, AWApiDeclaration, AWAppendEnvironment, AWArea, AWBackTrack, AWBareString, AWBaseElement, AWBaseImage, AWBaseMonitorStatsPage, AWBindableElement, AWBindingApi, AWBlock, AWBody, AWBrowser, AWCatch, AWCheckbox, AWClientSideScript, AWComment, AWCommunityResponse, AWComponent, AWComponentInclude, AWComponentReference, AWConcreteTemplate, AWConcreteXmlNode, AWContainerElement, AWContent, AWContentApi, AWCurrWindowDecl, AWDebugContent, AWDragContainer, AWDropContainer, AWEditableRegion, AWElse, AWEnvironment, AWErrorManagerScope, AWEvaluateTemplateFile, AWExampleApi, AWExampleComponent, AWExceptionBodyRenderer, AWFileDownload, AWFileUpload, AWFileUploadInternals, AWFocusRegion, AWFor, AWForm, AWFormRedirect, AWFrame, AWGenericActionTag, AWGenericContainer, AWGenericElement, AWGroupingRepetition, AWHead, AWHiddenFormParameter, AWHiddenFormValue, AWHighLightedErrorScope, AWHoverContainer, AWHoverControl, AWHtmlTemplateParser.LiteralContainer, AWHyperlink, AWIf, AWIf.AWIfBlock, AWIFrame, AWImage, AWImageButton, AWImageData, AWIncludeBlock, AWIncludeComponent, AWIncludeContent, AWIncludeExample, AWInitializeValue, AWInstanceInclude, AWJavascriptString, AWJSDebug, AWJSListRepetition, AWLabel, AWLazyAction, AWLazyDiv, AWLazyDivInternals, AWLocal, AWMappingRepetition, AWMessageArgument, AWMetaContentType, AWMetaRefresh, AWMetaTemplateConditional, AWMetaTemplateWrapper, AWMethodInvocation, AWMonitorSessionStatsPage, AWMultiTabException, AWOutputRangeCheck, AWPageRedirect, AWPageWrapper, AWParentTemplate, AWPasswordField, AWPhaseInvocation, AWPollInterval, AWPopup, AWPrimitiveString, AWPrivateHyperlink, AWPrivateScript, AWRadioButton, AWRadioButtonEnvironment, AWRedirect, AWRefreshRegion, AWRelocatableDiv, AWRemoteLink, AWRemotePageWrapper, AWResourceOverlay, AWResourceUrl, AWRichClientFooter, AWScope, AWSetValue, AWSingleton, AWStaticContent, AWStaticImage, AWString, AWStyleSheet, AWSubcomponentScope, AWSubmitButton, AWSwitchTemplate, AWTaggedContainer, AWTaggedElement, AWTBatchNavigationBar, AWTButtonArea, AWTButtonAreaRenderer, AWTColumn, AWTColumnRenderer, AWTCSVData, AWTDataTable, AWTDataTable.Column, AWTDataTable.ColumnRenderer, AWTDataTable.ProxyColumn, AWTdContainer, AWTdElement, AWTDragList, AWTDynamicColumns, AWTDynamicDetailAttributes, AWTemplate, AWTExportConditional, AWTextArea, AWTextField, AWTHeadingArea, AWTHeadingAreaRenderer, AWTMetaColumn, AWTMetaColumnRenderer, AWTMetaContent, AWTMetaContentRenderer, AWTMultiSelectColumn, AWTMultiSelectColumnRenderer, AWTOptionalColumnsPage, AWTOptionsMenuButton, AWTOptionsMenuItems, AWTPivotAttributesColumnRenderer, AWTPivotConfigurationPanel, AWTPivotState.PivotAttributesColumn, AWTPivotState.PivotEdgeColumn, AWTPivotState.RowAttributeExpandoColumn, AWTPivotState.RowAttributeLabelColumn, AWTRightButtonArea, AWTRowAttributeExpandoColumnRenderer, AWTRowAttributeLabelColumnRenderer, AWTRowDetail, AWTRowDetailExpandoColumn, AWTRowDetailExpandoColumn.Column, AWTRowDetailRenderer, AWTScrollTableWrapper, AWTSelectionButtonArea, AWTSingleSelectColumn, AWTSingleSelectColumnRenderer, AWTSortHeading, AWUrlRedirect, AWViewportContainer, AWVModalPageWrapper, AWVPasswordField, AWVPopup, AWVTextArea, AWVValidationInvocation, AWWhile, AWXBasicScriptFunctions, AWXHandleExceptionPage, AWXLogString, AWXSessionRestorationErrorPage, BaseTabSet, BasicNavigator, BasicPageWrapper, BrandedComponent, BrandingComponent, BucketHeading, BucketItem, BucketsTOC, Calendar, Chart, ChartData, ChartPivotData, CheckboxList, Chooser, ChooserPanel, ClientPanelWrapper, ComboButton, CommunityContentPane, CompactForm, CompactFormRow, ComplexRepetition, Confirmation, ConfirmationLink, CueTip, DateField, DefaultCommandBar, DeferredDisplayWrapper, DialogContentWrapper, DialogPageWrapper, DocumentHead, EarlyAccessBanner, ErrorBubble, ErrorFlag, ErrorIndicator, FileBrowser, FileUploadChooser, FileUploadStatusBar, FooterIncludes, FooterLinks, FormGroupBlock, FormRow, FormTable, FourZoneLayout, GenericChooser, GoogleAnalyticsFooter, GoogleAnalyticsHeader, GradientBox, HeaderIncludes, HintMessage, HoverCard, HTMLActionFilter, HtmlInclude, HyperlinkExample, ImagePrefetch, MapForEach, Markdown, MessageBanner, MessagesList, MetaActionList, MetaContentPage, MetaContext, MetaDashboardLayout, MetaDetailTable, MetaElementList, MetaForm, MetaHomePage, MetaIncludeComponent, MetaInspectorPane, MetaLayout, MetaList, MetaMarkdown, MetaModalPage, MetaNavCommandBar, MetaNavEditorMenu, MetaNavTabBar, MetaRange, MetaRules, MetaSearch, MetaSearchForm, MetaSections, MetaSideInspector, MetaTable, MetaTableColumn, MetaTableColumnRenderer, MetaTableColumns, MetaTableColumnsRenderer, MetaTableDetailColumnRenderer, MetaTableDetailColumnRenderer.Column, MetaTabs, MimeMessageView, ModalPageWrapper, ModalWindowClose, ModalWindowExceptionPage, ModalWindowLink, ModalWindowScriptFunctions, ModalWindowWrapper, MRUTabList, OutlineBox, OutlineControl, OutlineFolderControl, OutlineInnerRepetition, OutlineMenu, OutlineRepetition, PaddedImage, PageErrorPanel, PageWrapper, PageWrapperForm, PollDialog, PopupCalendar, PopupControl, PopupMenu, PopupMenuButton, PopupMenuHeading, PopupMenuItem, PopupMenuLink, PortletWrapper, PulldownButton, PunchOutHeader, RadioButtonList, RichTextArea, RichTextAreaScript, RoundedBox, RoundedCorners, RoundedStep, SearchBox, SectionBody, SectionHeading, SetterLink, SimpleTocPanel, Spotlight, SpotlightFooter, StepByStepTOC, StepHeader, StepNavigator, StepNavigatorBar, StepNavigatorButton, StepNavigatorButtonContent, SubmitButtonExample, Substep, Tab, TableHeaderRow, TabList, TabSet, TestComponentPage, TextButton, TextFieldExample, TextFieldExample2, TextFormSubmitButton, TocPanel, TocPanelItem, ToggleBox, ToggleBox.ToggleBoxElement, ToggleBoxBody, ToggleBoxHeading, ToggleImage, TopFrameRedirect, TruncateString, ValidatingTabSet, VirtualForm, WaterMark, WidgetInclude, WidgetsJavaScript, WizardAction, WizardButtonsBarBottom, WizardButtonsBarTop, WizardFrameContent, WizardNavigator, WizardPage, WizardPageWrapper, WizardTOC

public interface AWCycleable
extends AWObject

Defines the three critical request handling phase for "Component Actions". In the component action request handling cycle, a page, its root component, and the full tree of elements and subcomponents therein first go through renderResponse(ariba.ui.aribaweb.core.AWRequestContext, ariba.ui.aribaweb.core.AWComponent), and then, when the user performs an action on the page, will in the resulting follow-up request perform applyValues(ariba.ui.aribaweb.core.AWRequestContext, ariba.ui.aribaweb.core.AWComponent) and then invokeAction(ariba.ui.aribaweb.core.AWRequestContext, ariba.ui.aribaweb.core.AWComponent).

Method Summary

void	applyValues(AWRequestContext requestContext, AWComponent component) The receiver should take any form values (or query string parameters) that it owns from the AWRequestContext.request().
AWResponseGenerating	invokeAction(AWRequestContext requestContext, AWComponent component) The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()

Methods inherited from interface ariba.ui.aribaweb.util.AWObject

getFieldValue, init, isKindOfClass, setFieldValue

Method Detail

applyValues

void applyValues(AWRequestContext requestContext,
                 AWComponent component)

The receiver should take any form values (or query string parameters) that it owns from the AWRequestContext.request().

Parameters:

requestContext - the context for the current request.

component - the current parent component

invokeAction

AWResponseGenerating invokeAction(AWRequestContext requestContext,
                                  AWComponent component)

The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.

Parameters:

requestContext - the context for the current request.

component - the current parent component

Returns:

the response for the action

renderResponse

void renderResponse(AWRequestContext requestContext,
                    AWComponent component)

The receiver should render its content to the AWRequestContext.response()

Parameters:

requestContext - the context for the current request.

component - the current parent component