ariba.ui.aribaweb.core
Class AWApi

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWBaseElement
          ariba.ui.aribaweb.core.AWBindableElement
              ariba.ui.aribaweb.core.AWContainerElement
                  ariba.ui.aribaweb.core.AWApi

All Implemented Interfaces:

AWBindable, AWCycleable, AWCycleableReference, AWElement, AWElementContaining, AWVisitable, AWObject, java.lang.Cloneable

public final class AWApi
extends AWContainerElement

Description in here For the Binding meta tag, the following attributes are allowed/expected: key: [required] appears on the left side of the binding (eg action="$linkClicked" -- here 'action' is the key) direction: [required] either set, get, or both, depending on if the binding is for getting, setting, or both. type: [required] the class that is returned or should be passed when being set/get. required: [alternate:default] true/false or, if not provided, assumed to be false. default: [alternate:required] cannot exist if required=$true, but indicates the default value if required is false. alternates: [optional] if not required, then a list alternate keys may be specified in its place, but only one from the list may be used. deprecated: [optional] defaults to false. If true, users should not use and will get a deprecated warning.

Field Summary

Fields inherited from class ariba.ui.aribaweb.util.AWBaseObject

AribaHashtableClass, AribaVectorClass, ClassClass, EmptyHashtable, EmptyMap, EmptyVector, False, IntegerClass, JavaHashtableClass, JavaMapClass, JavaVectorClass, LogHandling, NullObject, ObjectClass, StringClass, True, UndefinedObject, UndefinedString, UninitializedRealNumber

Constructor Summary

AWApi()

Method Summary

boolean	allowsPassThrough()
void	applyValues(AWRequestContext requestContext, AWComponent component) The receiver should take any form values (or query string parameters) that it owns from the AWRequestContext.request().
AWBindingApi[]	bindingApis()
AWContentApi[]	contentApis()
AWExampleApi[]	exampleApis()
AWIncludeExample[]	includeExamples()
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.
AWGenericContainer	locateTagNamed(java.lang.String tagName)
AWElement	overview()
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
AWEncodedString	responsible()
void	validate(AWValidationContext validationContext, AWComponent component) Checks for things like valid binding names and definitions.
boolean	validateRequiredBindings(AWValidationContext validationContext, AWComponent component, AWBindingDictionary bindings)

Methods inherited from class ariba.ui.aribaweb.core.AWContainerElement

add, appendTo, contentElement, continueVisit, setContentElement

Methods inherited from class ariba.ui.aribaweb.core.AWBindableElement

allBindings, determineInstance, init, tagName

Methods inherited from class ariba.ui.aribaweb.core.AWBaseElement

bareStringContent, clone, determineInstance, lineNumber, setLineNumber, setTemplateName, startVisit, templateName, toString

Methods inherited from class ariba.ui.aribaweb.util.AWBaseObject

debugString, ensureFieldValuesClear, getFieldValue, init, isKindOfClass, localizedJavaString, logString, logWarning, setFieldValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ariba.ui.aribaweb.core.AWElement

clone

Methods inherited from interface ariba.ui.aribaweb.core.AWCycleableReference

determineInstance

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

getFieldValue, init, isKindOfClass, setFieldValue

Methods inherited from interface ariba.ui.aribaweb.core.AWVisitable

startVisit

Constructor Detail

AWApi

public AWApi()

Method Detail

bindingApis

public AWBindingApi[] bindingApis()

contentApis

public AWContentApi[] contentApis()

exampleApis

public AWExampleApi[] exampleApis()

includeExamples

public AWIncludeExample[] includeExamples()

locateTagNamed

public AWGenericContainer locateTagNamed(java.lang.String tagName)

overview

public AWElement overview()

responsible

public AWEncodedString responsible()

applyValues

public void applyValues(AWRequestContext requestContext,
                        AWComponent component)

Description copied from interface: AWCycleable

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

Specified by:

applyValues in interface AWCycleable

Overrides:

applyValues in class AWContainerElement

Parameters:

requestContext - the context for the current request.

component - the current parent component

invokeAction

public AWResponseGenerating invokeAction(AWRequestContext requestContext,
                                         AWComponent component)

Description copied from interface: AWCycleable

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.

Specified by:

invokeAction in interface AWCycleable

Overrides:

invokeAction in class AWContainerElement

Parameters:

requestContext - the context for the current request.

component - the current parent component

Returns:

the response for the action

renderResponse

public void renderResponse(AWRequestContext requestContext,
                           AWComponent component)

Description copied from interface: AWCycleable

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

Specified by:

renderResponse in interface AWCycleable

Overrides:

renderResponse in class AWContainerElement

Parameters:

requestContext - the context for the current request.

component - the current parent component

validateRequiredBindings

public boolean validateRequiredBindings(AWValidationContext validationContext,
                                        AWComponent component,
                                        AWBindingDictionary bindings)

allowsPassThrough

public boolean allowsPassThrough()

validate

public void validate(AWValidationContext validationContext,
                     AWComponent component)

Description copied from class: AWBaseElement

Checks for things like valid binding names and definitions. Logs all errors and warnings. This is the default, which is to do nothing.

Specified by:

validate in interface AWElement

Overrides:

validate in class AWContainerElement