com.webobjects.appserver
Class WOContext

java.lang.Object
  com.webobjects.appserver.WOContext

All Implemented Interfaces:

NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, Cloneable

Direct Known Subclasses:

WOServletContext

public class WOContext
extends Object
implements Cloneable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions

A WOContext object lets you access objects and information that define the context of a transaction. In a typical request-response loop (a transaction), several objects have a hand in what is going on: the WOApplication and WOSession objects, the page involved in the request or response (a WOComponent object), the page's subcomponents (also WOComponents), plus the dynamic elements on the page. The WOContext object passed as an argument in the takeValuesFromRequest, invokeAction, and appendToResponse methods allows access to these objects. A context is identified by the contextID, which appears in the URL after the session ID and page name. Each contextID is an integer that the session increments each time a new context is created.

WOContext objects provide other information and services related to the current transaction. From them you can get the entire URL currently in effect as well as portions of that URL, such as the element ID, the context ID, and the URL up to and including the session ID.

A WOContext object plays a further role behind the scenes. For the benefit of a page's dynamic elements, it keeps track of the current component, that is, the WOComponent associated with the current element in the request-handling cycle. The current component can be the WOComponent that represents one of the page's subcomponents or the page itself. By reference to the current component,accessed through WOContext's component method, a dynamic element can exchange values associatively between itself and the WOComponent that contains it.

See Also:

WOContext.component(), WOComponent.takeValuesFromRequest(WORequest aRequest, WOContext aContext), WOComponent.invokeAction(WORequest aRequest, WOContext aContext), WOComponent.appendToResponse(WOResponse aResponse, WOContext aContext)

Nested Class Summary

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Field Summary

static boolean	EscapeQueryDictionary
static String	SessionIDBindingKey wosid
static String	WOURLEncoding Resolves to string 'WOURLEncoding'

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

KeyPathSeparator

Constructor Summary

WOContext(WORequest aRequest)
Returns a WOContext instance initialized with aRequest.

Method Summary

void	appendElementIDComponent(String aString) Appends a string to the current element ID to create an identifier of an HTML element.
void	appendZeroElementIDComponent() Appends a ".0" to the current element ID to create an identifier of the first "child" HTML element.
static boolean	canAccessFieldsDirectly() WOContext's implementation of this static method returns true, indicating that key/value coding is allowed to access fields in this object if an appropriate method isn't present.
Object	clone()
String	completeApplicationURLPrefix(boolean secure, int port) Returns the application url prefix, including the application number.If port is 0 then the url will default to 443 for secure url and the default server port otherwise.
String	completeURLWithRequestHandlerKey(String requestHandlerKey, String aRequestHandlerPath, String aQueryString, boolean isSecure, int somePort) Returns the complete URL for the specified request handler.
String	completeURLWithRequestHandlerKey(String applicationNumber, String requestHandlerKey, String requestHandlerPath, String queryString, boolean isSecure, int somePort) Builds a complete URL from its components.
WOComponent	component() Returns the WOComponent that dynamic elements are currently using to push and pull values associatively.
String	componentActionURL() Returns a URL for a component action relative to cgi-bin/WebObjects.
String	componentActionURL(String requestHandlerKey) Returns a URL for a component action relative to cgi-bin/WebObjects.
String	componentActionURL(String requestHandlerKey, boolean isSecure) Returns a URL for a component action relative to cgi-bin/WebObjects.
NSDictionary	computeQueryDictionary(String aRequestHandlerPath, NSDictionary queryDictionary, NSDictionary otherQueryDictionary, boolean defaultIncludeSessionID) Compute a combined query dictionary.
String	contextID() Returns the context ID of the receiver.
static WOContext	contextWithRequest(WORequest aRequest) Deprecated. use WOContext(WORequest aRequest) instead
void	deleteAllElementIDComponents() Deletes all components of the current element ID.
void	deleteLastElementIDComponent() Deletes the last digit --or name-- of the current element ID, along with its dot separator.
String	directActionURLForActionNamed(String anActionName, NSDictionary queryDictionary) Returns a complete URL for the specified action.
String	directActionURLForActionNamed(String requestHandlerPath, NSDictionary queryDictionary, boolean isSecure, boolean entityEscapeQueryDict) Builds a complete URL from its components for a direct action.
String	directActionURLForActionNamed(String aRequestHandlerPath, NSDictionary queryDictionary, boolean isSecure, int somePort, boolean entityEscapeQueryDict) Builds a complete URL from its components for a direct action.
protected boolean	directConnect()
boolean	doesGenerateCompleteURLs() Return the value of teh Generate complete URLs variable
String	elementID() Returns an element ID.
void	generateCompleteURLs() Forces the context to generate complete URLs.
void	generateRelativeURLs() Forces the context to generate relative URLs.
Object	handleQueryWithUnboundKey(String key) Invoked from valueForKey when it finds no property binding for key.
void	handleTakeValueForUnboundKey(Object value, String key) Invoked from takeValueForKey when it finds no property binding for key.
boolean	hasSession() Returns true if a session exists for the receiving context, false otherwise.
void	incrementLastElementIDComponent() Increments the last digit of the current element ID.
boolean	isInForm() Used by subclasses of WODynamicElement to determine if the context is in a WOForm element.
boolean	isMultipleSubmitForm() Convenience to determine if multiple submit form was submitted
String	javaScriptElementID() Returns a JavaScript safe element id.
static String	javaScriptElementIDPrefix() Returns the prefix for the JavaScript element id.
static String	javaScriptElementIDSeparator() Returns the separator for the JavaScript element id.
WOComponent	page() Returns a WOComponent object that represents either the request or response page.
String	pageFragementID() Returns the ID used in the page fragment cache to identify the component.
protected String	relativeURLWithRequestHandlerKey(String requestHandlerKey, String requestHandlerPath, String queryString)
WORequest	request() Return the context's WORequest object.
WOResponse	response() Return the context's WOResponse object.
boolean	secureMode() Return true if the context is in secure mode.
protected boolean	secureRequest() Return the secure state of the request
String	senderID() Returns the part of the WORequest's URI that identifies the dynamic element on the page (such as a form or an active image) responsible for submitting the request.
WOSession	session() Returns the object representing the receiving context's session, if one exists.
protected Object	sessionIDInQueryDictionary(NSDictionary queryDictionary)
void	setActionInvoked(boolean aFlag) Convenience to set if action was invoked
void	setFormSubmitted(boolean aFlag) Convenience to set if form as submitted
void	setInForm(boolean aFlag) If you write something that behaves like a WOForm, invoke this method with aFlag true in appendToResponse(WOResponse aResponse, WOContext aContext) before calling super.appendToResponse(WOResponse aResponse, WOContext aContext) to notify any contained WODynamicElements that they are in a form.
void	setIsMultipleSubmitForm(boolean aFlag) Convenience to set if multiple submit form was submitted
static void	setJavaScriptElementIDPrefix(String value) Sets the prefix for the JavaScript element id.
static void	setJavaScriptElementIDSeparator(String value) Sets the separator for the JavaScript element id.
void	setPageFragmentID(String value) Stes the ID used in the page fragment cache to identify the component.
void	setSecureMode(boolean value) Puts the context in secure mode.
void	setUserInfo(Map aDictionary) Sets a dictionary in the WOContext object that can contain, as a convenience, any kind of information related to the current response.
void	setUserInfoForKey(Object value, String key) Setes the value for key in the infor user dictionary
boolean	shouldNotStorePageInBacktrackCache() Checks if the page should not be stored in the backtrack cache.
void	takeValueForKey(Object value, String key) Sets the value for the property identified by key to value.
void	takeValueForKeyPath(Object value, String keyPath) Sets the value for the property identified by keyPath to value.
String	toString()
void	unableToSetNullForKey(String key) Invoked from takeValueForKey when it is given a null value for a scalar property (such as an int or a float).
String	urlWithRequestHandlerKey(String requestHandlerKey, String aRequestHandlerPath, String aQueryString) Returns a URL relative to cgi-bin/WebObjects for the specified request handler.
NSDictionary	userInfo() Return the userInfo dictionary.
Object	userInfoForKey(String key) Return the value of the key in the userInfo dictionary
Object	valueForKey(String key) Retrieves the value of the property named by key.
Object	valueForKeyPath(String keyPath) Retrieves the value of a property of the object at the end of the key path (a key path is a string of the form "key1.key2").
boolean	wasActionInvoked() Convenience to determine if action was invoked
boolean	wasFormSubmitted() Convenience to determine if form as submitted

Methods inherited from class java.lang.Object

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

Field Detail

WOURLEncoding

public static final String WOURLEncoding

Resolves to string 'WOURLEncoding'

See Also:

Constant Field Values

SessionIDBindingKey

public static final String SessionIDBindingKey

wosid

See Also:

Constant Field Values

EscapeQueryDictionary

public static boolean EscapeQueryDictionary

Constructor Detail

WOContext

public WOContext(WORequest aRequest)

Returns a WOContext instance initialized with aRequest.

Parameters:

aRequest - request that initializes the instance

Method Detail

contextWithRequest

@Deprecated
public static WOContext contextWithRequest(WORequest aRequest)

Deprecated. use WOContext(WORequest aRequest) instead

Deprecated.

Parameters:

aRequest - WORequest

Returns:

an instance of WOContext initialized with aRequest

secureRequest

protected boolean secureRequest()

Return the secure state of the request

Returns:

true if the request was made over a secure connection

Since:

5.4

secureMode

public boolean secureMode()

Return true if the context is in secure mode.

Returns:

true if in secure mode

Since:

5.4

setSecureMode

public void setSecureMode(boolean value)

Puts the context in secure mode.

Parameters:

value -

clone

public Object clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object

contextID

public String contextID()

Returns the context ID of the receiver.

Returns:

the context ID of the receiver

senderID

public String senderID()

Returns the part of the WORequest's URI that identifies the dynamic element on the page (such as a form or an active image) responsible for submitting the request. The sender ID is the same as the element ID used to identify the dynamic element. A request's sender ID may be null, as it always is on the first request of a session.

Returns:

the part of the WORequest's URI that identifies a dynamic element on a page

See Also:

WOContext.request(), WORequest.uri()

hasSession

public boolean hasSession()

Returns true if a session exists for the receiving context, false otherwise.

Returns:

true if a session exists for the receiving context, false otherwise

See Also:

WOContext.session()

session

public WOSession session()

Returns the object representing the receiving context's session, if one exists. If the receiver does not have a session, this method creates a new session object and returns it. Note that not all contexts have a session: Direct Actions, for instance, don't always need a session. use hasSession to determine whether a context has a session associated with it.

In the case of a direct action, if a session could not be restored from a session ID this method attempts to create a new session by calling WOApplication.createSessionForRequest. If createSessionForRequest returns null, this method throws an IllegalStateException (catch it in your direct action to manually handle session creation error).

Returns:

the object representing the receiving context's session

See Also:

WOContext.component(), WOContext.page(), WOContext.request(), WOContext.response(), WOContext.hasSession(), WOSession, WOApplication.createSessionForRequest(com.webobjects.appserver.WORequest)

request

public WORequest request()

Return the context's WORequest object.

Returns:

the receiver's WORequest object

See Also:

WOContext.component(), WOContext.page(), WOContext.response(), WOContext.session()

response

public WOResponse response()

Return the context's WOResponse object.

Returns:

the receiver's WOResponse object

See Also:

WOContext.component(), WOContext.page(), WOContext.response(), WOContext.session()

setInForm

public void setInForm(boolean aFlag)

If you write something that behaves like a WOForm, invoke this method with aFlag true in appendToResponse(WOResponse aResponse, WOContext aContext) before calling super.appendToResponse(WOResponse aResponse, WOContext aContext) to notify any contained WODynamicElements that they are in a form. After super.appendToResponse(WOResponse aResponse, WOContext aContext) is done, revert the change by invoking invoke this method with aFlag false.

Parameters:

aFlag - truenotifies WODynamicElements that they are in a form

See Also:

WOContext.isInForm()

isInForm

public boolean isInForm()

Used by subclasses of WODynamicElement to determine if the context is in a WOForm element.

Returns:

returns true when in the context of a WOForm, false otherwise

See Also:

WOContext.setInForm(boolean flag)

setFormSubmitted

public void setFormSubmitted(boolean aFlag)

Convenience to set if form as submitted

Parameters:

aFlag - boolean to indicate whether form was submitted

Since:

5.4

wasFormSubmitted

public boolean wasFormSubmitted()

Convenience to determine if form as submitted

Returns:

true if form was submitted

Since:

5.4

setActionInvoked

public void setActionInvoked(boolean aFlag)

Convenience to set if action was invoked

Parameters:

aFlag - set to true if action was invoked

Since:

5.4

wasActionInvoked

public boolean wasActionInvoked()

Convenience to determine if action was invoked

Returns:

true if action was invoked

Since:

5.4

setIsMultipleSubmitForm

public void setIsMultipleSubmitForm(boolean aFlag)

Convenience to set if multiple submit form was submitted

Parameters:

aFlag - set to true if multiple submit form was submitted

Since:

5.4

isMultipleSubmitForm

public boolean isMultipleSubmitForm()

Convenience to determine if multiple submit form was submitted

Returns:

true if multiple submit form was set

Since:

5.4

setUserInfo

public void setUserInfo(Map aDictionary)

Sets a dictionary in the WOContext object that can contain, as a convenience, any kind of information related to the current response. Objects further down the appendToResponse method chain can retrieve this information by invoking userInfo.

This method unconditionally makes an immutable copy of aDictionary. This can be a problem if changes made elsewhere to the dictionary's contents need to be reflected in the userInfo dictionary.

If you need to pass in a mutable dictionary that can be changed by other objects down the chain, wrap the mutable dictionary in a read-only (immutable) dictionary and pass the immutable dictionary as the argument to this method. Be extremely careful doing this if your application is multi-threaded and the userInfo data may be accessed by multiple threads.

Parameters:

aDictionary - a dictionary that can contain any kind of information related to the current response

Since:

5.4

See Also:

WOContext.userInfo()

userInfo

public NSDictionary userInfo()

Return the userInfo dictionary. An object further upstream in the appendToResponse method chain can set this dictionary in the WOMessage object as a way to pass information to other objects.

Returns:

a dictionary that can contain any kind of information related to the current response

Since:

5.4

See Also:

WOContext.setUserInfo(Map)

userInfoForKey

public Object userInfoForKey(String key)

Return the value of the key in the userInfo dictionary

Parameters:

key - to search for

Returns:

value for key

Since:

5.4

setUserInfoForKey

public void setUserInfoForKey(Object value,
                              String key)

Setes the value for key in the infor user dictionary

Parameters:

value - to set

key - to set

Since:

5.4

page

public WOComponent page()

Returns a WOComponent object that represents either the request or response page. If this method is called during the takeValuesFromRequestinvokeAction phases of request handling, it will return the request page. If it is called during appendToResponse phase, it will return the response page. During the first two phases, the request page is determined by the context ID in the request -- if one exists, and is restored from the user's session's page cache.

Returns:

a WOComponent object that represents either the request or response page

See Also:

WOContext.component(), WOContext.request(), WOContext.response(), WOContext.session(), WOSession.restorePageForContextID(String aContextID)

component

public WOComponent component()

Returns the WOComponent that dynamic elements are currently using to push and pull values associatively. During the takeValuesFromRequestinvokeAction phases of request handling, this will be either the current request, or a subcomponent of that page. During the appendToResponse phase, it will return the response page or a subcomponent.

Returns:

a WOComponent

See Also:

WOContext.page(), WOContext.request(), WOContext.response(), WOContext.session(), WOComponent

elementID

public String elementID()

Returns an element ID. This element ID is used by WOElements during the appendToResponse phase of request handling to create URLs, and during the invokeAction phase to determine which element was activated. This element ID will change as appendElementIDComponent etc are invoked.

Returns:

the element ID identifying the current WOElement

See Also:

WOContext.appendElementIDComponent(String aString), WOContext.appendZeroElementIDComponent(), WOContext.deleteAllElementIDComponents(), WOContext.deleteLastElementIDComponent(), WOContext.incrementLastElementIDComponent()

javaScriptElementID

public String javaScriptElementID()

Returns a JavaScript safe element id. This element is prefixed with javaScriptElementIDPrefix and all element are separated by "_"

Returns:

the Javascript element ID identifying the current WOElement

Since:

5.4

See Also:

WOContext.javaScriptElementIDPrefix()

javaScriptElementIDPrefix

public static String javaScriptElementIDPrefix()

Returns the prefix for the JavaScript element id.

Returns:

the Javascript prefix

Since:

5.4

See Also:

WOContext.javaScriptElementID()

setJavaScriptElementIDSeparator

public static void setJavaScriptElementIDSeparator(String value)

Sets the separator for the JavaScript element id.

Parameters:

value - the Javascript separator

Since:

5.4

See Also:

WOContext.javaScriptElementID()

javaScriptElementIDSeparator

public static String javaScriptElementIDSeparator()

Returns the separator for the JavaScript element id.

Returns:

the Javascript separator

Since:

5.4

See Also:

WOContext.javaScriptElementID()

setJavaScriptElementIDPrefix

public static void setJavaScriptElementIDPrefix(String value)

Sets the prefix for the JavaScript element id.

Parameters:

value - the Javascript prefix

Since:

5.4

See Also:

WOContext.javaScriptElementID()

shouldNotStorePageInBacktrackCache

public boolean shouldNotStorePageInBacktrackCache()

Checks if the page should not be stored in the backtrack cache.

Returns:

true if the page should not be stored

Since:

5.4

pageFragementID

public String pageFragementID()

Returns the ID used in the page fragment cache to identify the component. This defaults to javaScriptElementID

Returns:

the name of the page fragment

Since:

5.4

See Also:

WOContext.javaScriptElementID()

setPageFragmentID

public void setPageFragmentID(String value)

Stes the ID used in the page fragment cache to identify the component.

Parameters:

value - name of the page fragment

Since:

5.4

generateCompleteURLs

public void generateCompleteURLs()

Forces the context to generate complete URLs.

generateRelativeURLs

public void generateRelativeURLs()

Forces the context to generate relative URLs.

doesGenerateCompleteURLs

public boolean doesGenerateCompleteURLs()

Return the value of teh Generate complete URLs variable

Returns:

boolean

completeURLWithRequestHandlerKey

public String completeURLWithRequestHandlerKey(String applicationNumber,
                                               String requestHandlerKey,
                                               String requestHandlerPath,
                                               String queryString,
                                               boolean isSecure,
                                               int somePort)

Builds a complete URL from its components. This methods always return a complete

Parameters:

applicationNumber - application number if not included in the request

requestHandlerKey - request Handler Key (from the application request handlers)

requestHandlerPath - Action or Page that need to be accessed

queryString - Query String to append

isSecure - Generate https or http protocol

somePort - If not port 80

Returns:

page URL

completeApplicationURLPrefix

public String completeApplicationURLPrefix(boolean secure,
                                           int port)

Returns the application url prefix, including the application number.If port is 0 then the url will default to 443 for secure url and the default server port otherwise.

Parameters:

secure - generates secure url (https)

port - use a specific port.

Returns:

application url.

directActionURLForActionNamed

public String directActionURLForActionNamed(String anActionName,
                                            NSDictionary queryDictionary)

Returns a complete URL for the specified action. anActionName can be either an action -- "ActionName" -- or an action on a class -- "ActionClass/ActionName". You can also specify aQueryDict to be an NSDictionary which contains form values as key/value pairs.

Parameters:

anActionName - String action name

queryDictionary - NSDictionary containing query key/value pairs

Returns:

a String containing the URL for the specified action

See Also:

WODirectAction

componentActionURL

public String componentActionURL()

Returns a URL for a component action relative to cgi-bin/WebObjects. The exact form of the URL will vary depending on whether the application is caching pages and whether the session ID is being stored in the URL or not.

Returns:

the URL for a component action

componentActionURL

public String componentActionURL(String requestHandlerKey)

Returns a URL for a component action relative to cgi-bin/WebObjects. The exact form of the URL will vary depending on whether the application is caching pages and whether the session ID is being stored in the URL or not.

Parameters:

requestHandlerKey - Request handler key to be used in the URL

Returns:

the URL for a component action

componentActionURL

public String componentActionURL(String requestHandlerKey,
                                 boolean isSecure)

Returns a URL for a component action relative to cgi-bin/WebObjects. The exact form of the URL will vary depending on whether the application is caching pages and whether the session ID is being stored in the URL or not.

Parameters:

requestHandlerKey - Request handler key to be used in the URL

isSecure - Generates secure or regular URLs

Returns:

string URL for the component action

urlWithRequestHandlerKey

public String urlWithRequestHandlerKey(String requestHandlerKey,
                                       String aRequestHandlerPath,
                                       String aQueryString)

Returns a URL relative to cgi-bin/WebObjects for the specified request handler. The requestHandlerKey is one of the keys registered with WOApplication. The aRequestHandlerPath is any URL encoded string. The aQueryString is added at the end of the URL behind a "?".

Parameters:

requestHandlerKey - one of the keys provided by WOApplication

aRequestHandlerPath - any URL encoded string

aQueryString - string added at the end of the URL

Returns:

returns a URL relative to cgi-bin/WebObjects for the specified request handler

See Also:

(String requestHandlerKey, String aRequestHandlerPath, String aQueryString, boolean isSecure,int somePort), WOApplication.registeredRequestHandlerKeys()

directActionURLForActionNamed

public String directActionURLForActionNamed(String aRequestHandlerPath,
                                            NSDictionary queryDictionary,
                                            boolean isSecure,
                                            int somePort,
                                            boolean entityEscapeQueryDict)

Builds a complete URL from its components for a direct action. This methods always return a complete URL.

Parameters:

aRequestHandlerPath - Action that need to be accessed

queryDictionary - Query Dictionary to append

isSecure - Generate https or http protocol

somePort - If not port 80

entityEscapeQueryDict - true if you want the query dictionary generated as foo=bar&baz=blah as opposed to foo=bar&baz=blah

Returns:

page URL

computeQueryDictionary

public NSDictionary computeQueryDictionary(String aRequestHandlerPath,
                                           NSDictionary queryDictionary,
                                           NSDictionary otherQueryDictionary,
                                           boolean defaultIncludeSessionID)

Compute a combined query dictionary. The resulting dictionary will include the session id if necessary. The session id inclusion can be prevented by adding a wosid entry in either of teh dictionaries.

Parameters:

aRequestHandlerPath - Action that need to be accessed

queryDictionary - Query Dictionary to append

otherQueryDictionary - Query Dictionary to append

defaultIncludeSessionID - if the session ID is not null and not included by another mean do we force its inclusion

Returns:

complete query dictionary

directActionURLForActionNamed

public String directActionURLForActionNamed(String requestHandlerPath,
                                            NSDictionary queryDictionary,
                                            boolean isSecure,
                                            boolean entityEscapeQueryDict)

Builds a complete URL from its components for a direct action. This methods always return a complete URL.

Parameters:

requestHandlerPath - Action that need to be accessed

queryDictionary - Query dictionary to append

isSecure - Generate https or http protocol

Returns:

page URL

relativeURLWithRequestHandlerKey

protected String relativeURLWithRequestHandlerKey(String requestHandlerKey,
                                                  String requestHandlerPath,
                                                  String queryString)

Parameters:

requestHandlerKey -

requestHandlerPath -

queryString -

Returns:

relative URL string

sessionIDInQueryDictionary

protected Object sessionIDInQueryDictionary(NSDictionary queryDictionary)

directConnect

protected boolean directConnect()

completeURLWithRequestHandlerKey

public String completeURLWithRequestHandlerKey(String requestHandlerKey,
                                               String aRequestHandlerPath,
                                               String aQueryString,
                                               boolean isSecure,
                                               int somePort)

Returns the complete URL for the specified request handler. The requestHandlerKey is one of the keys registered with WOApplication. The requestHandlerPath is any URL encoded string. The aQueryString is added at the end of the URL behind a "?". If isSecure is true, this method uses "https" instead of "http". If somePort is 0 (zero), this method uses the default port.

Parameters:

requestHandlerKey - one of the keys registered with WOApplication

aRequestHandlerPath - any URL encoded string

aQueryString - added at the end of the URL

isSecure - if true the method uses "https" instead of "http"

somePort - the port on which the request handler is listening if 0 this method uses the default port request handler

Returns:

String with the complete URL for the specified request handler

See Also:

WOContext.urlWithRequestHandlerKey(String requestHandlerKey, String aRequestHandlerPath, String aQueryString), WOApplication.registeredRequestHandlerKeys()

appendElementIDComponent

public void appendElementIDComponent(String aString)

Appends a string to the current element ID to create an identifier of an HTML element. For example, if the current element ID is "0.1.1" and this method is invoked with an argument of "NameField," the element ID for that field becomes "0.1.1.NameField".

Parameters:

aString - String to be appended to the current element ID

See Also:

WOContext.appendZeroElementIDComponent(), WOContext.deleteAllElementIDComponents(), WOContext.deleteLastElementIDComponent(), WOContext.incrementLastElementIDComponent()

appendZeroElementIDComponent

public void appendZeroElementIDComponent()

Appends a ".0" to the current element ID to create an identifier of the first "child" HTML element. For example, if the current element ID is "0.1.1", after this method is invoked the element ID becomes "0.1.1.0".

See Also:

WOContext.appendElementIDComponent(String aString), WOContext.deleteAllElementIDComponents(), WOContext.deleteLastElementIDComponent(), WOContext.incrementLastElementIDComponent()

incrementLastElementIDComponent

public void incrementLastElementIDComponent()

Increments the last digit of the current element ID. For example, after this method is invoked, "0.0.1.2" becomes "0.0.1.3".

See Also:

WOContext.appendElementIDComponent(String aString), WOContext.appendZeroElementIDComponent(), WOContext.deleteAllElementIDComponents(), WOContext.deleteLastElementIDComponent()

deleteLastElementIDComponent

public void deleteLastElementIDComponent()

Deletes the last digit --or name-- of the current element ID, along with its dot separator. Thus, after invoking this method, "0.0.1.1" becomes "0.0.1".

See Also:

WOContext.appendElementIDComponent(String aString), WOContext.appendZeroElementIDComponent(), WOContext.deleteAllElementIDComponents(), WOContext.incrementLastElementIDComponent()

deleteAllElementIDComponents

public void deleteAllElementIDComponents()

Deletes all components of the current element ID.

See Also:

WOContext.appendElementIDComponent(String aString), WOContext.appendZeroElementIDComponent(), WOContext.deleteLastElementIDComponent(), WOContext.incrementLastElementIDComponent()

canAccessFieldsDirectly

public static boolean canAccessFieldsDirectly()

WOContext's implementation of this static method returns true, indicating that key/value coding is allowed to access fields in this object if an appropriate method isn't present.

Returns:

true

valueForKey

public Object valueForKey(String key)

Description copied from interface: NSKeyValueCoding

Retrieves the value of the property named by key.

The default implementation provided by NSKeyValueCoding.DefaultImplementation works as follows:

1. Searches for a public accessor method based on key. For example, with a key of "lastName", the method looks for a method named getLastName, lastName, or isLastName.
2. If a public accessor method is not found, searches for a private accessor method based on key (a method preceded by an underbar). For example, with a key of "lastName", the method looks for a method named _getLastName, _lastName, or _isLastName
3. If an accessor method is not found and the static method canAccessFieldsDirectly returns true, the method searches for a field based on key and returns its value directly. For the key "lastName", this would be _lastName, _isLastName, lastName, or isLastName.
4. If neither an accessor method nor a field is found, the method invokes handleQueryWithUnboundKey (defined in NSKeyValueCoding.ErrorHandling).

Note: The default implementations have significant performance optimizations. To benefit from them, implement NSKeyValueCoding on a custom class as shown above by using the methods in NSKeyValueCoding.DefaultImplementation, or if your class inherits from an WebObjects class that implements NSKeyValueCoding, do not override the inherited implementation. Using a custom implementation incurs significant performance penalties.

Specified by:

valueForKey in interface NSKeyValueCoding

Parameters:

key - identifies the property to retrieve

Returns:

the value of the property identified by key. Depending on the object you invoke this method upon, null may be replaced with NullValue

See Also:

NSKeyValueCoding.NullValue, NSKeyValueCoding.takeValueForKey(java.lang.Object, java.lang.String), NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.ErrorHandling.handleQueryWithUnboundKey(java.lang.String)

takeValueForKey

public void takeValueForKey(Object value,
                            String key)

Description copied from interface: NSKeyValueCoding

Sets the value for the property identified by key to value.

The default implementation provided by NSKeyValueCoding.DefaultImplementation works as follows:

1. Searches for a public accessor method of the form setKey, and invokes it if there is one.
2. If a public accessor method is not found, searches for a private accessor method of the form _setKey, and invokes it if there is one.
3. If an accessor method is not found and the static method canAccessFieldsDirectly returns true, searches for a field based on key and sets its value directly. For the key "lastName", this would be _lastName, _isLastName, lastName, or isLastName.
4. If the type of the value argument is not compatible with the underlying field or method parameter, the default implementation will make an effort to convert between different Java numeric types (Integer, Double, BigDecimal, etc) as well as between Boolean and Number (true = 1, false = 0). If any other conversion would be necessary, an exception is thrown.
5. If neither an accessor method nor a field is found, it is an error condition. It invokes handleTakeValueForUnboundKey if the object implements NSKeyValueCoding.ErrorHandling or throws NSKeyValueCoding.UnknownKeyException if the object does not.

Note: : The default implementations have significant performance optimizations. To benefit from them, implement NSKeyValueCoding on a custom class as shown above by using the methods in NSKeyValueCoding. DefaultImplementation, or if your class inherits from an WebObjects class that implements NSKeyValueCoding, do not override the inherited implementation. Using a custom implementation incurs significant performance penalties.

Specified by:

takeValueForKey in interface NSKeyValueCoding

Parameters:

value - the new value for the property named by key

key - identifies the property to change

See Also:

NSKeyValueCoding.NullValue, NSKeyValueCoding.valueForKey, NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.ErrorHandling.handleTakeValueForUnboundKey(java.lang.Object, java.lang.String)

handleQueryWithUnboundKey

public Object handleQueryWithUnboundKey(String key)

Description copied from interface: NSKeyValueCoding.ErrorHandling

Invoked from valueForKey when it finds no property binding for key. The default implementation throws an NSKeyValueCoding.UnknownKeyException, with the target object(TargetObjectUserInfoKey) and key(UnknownUserInfokey) in the user info. An NSKeyValueCoding.ErrorHandling class can override this method to handle the query in some other way. The method can return a value, in which case that value is returned by the corresponding valueForKey invocation.

Specified by:

handleQueryWithUnboundKey in interface NSKeyValueCoding.ErrorHandling

Parameters:

key - the property name which generated this error

Returns:

any Object or null that the custom implementation desires. The default implementation throws an exception instead.

See Also:

NSKeyValueCoding.valueForKey, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.DefaultImplementation

handleTakeValueForUnboundKey

public void handleTakeValueForUnboundKey(Object value,
                                         String key)

Description copied from interface: NSKeyValueCoding.ErrorHandling

Invoked from takeValueForKey when it finds no property binding for key. The default implementation throws an NSKeyValueCoding.UnknownKeyException, with the target object(TargetObjectUserInfoKey) and key(UnknownUserInfoKey) in the user info dictionary of the exception. An NSKeyValueCoding.ErrorHandling class can override this method to handle the error in some other way.

Specified by:

handleTakeValueForUnboundKey in interface NSKeyValueCoding.ErrorHandling

Parameters:

value - the new value which could not be set

key - the name of the property which generated this error

See Also:

NSKeyValueCoding.takeValueForKey, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.DefaultImplementation

unableToSetNullForKey

public void unableToSetNullForKey(String key)

Description copied from interface: NSKeyValueCoding.ErrorHandling

Invoked from takeValueForKey when it is given a null value for a scalar property (such as an int or a float). The default implementation throws an IllegalArgumentException. You might want to implement the method (or override the inherited implementation) to handle the request in some other way, such as by substituting new Integer(0) or a sentinel value and invoking takeValueForKey again.

Specified by:

unableToSetNullForKey in interface NSKeyValueCoding.ErrorHandling

Parameters:

key - the name of the property which generated this error

See Also:

NSKeyValueCoding.takeValueForKey, NSKeyValueCoding.DefaultImplementation

valueForKeyPath

public Object valueForKeyPath(String keyPath)

Description copied from interface: NSKeyValueCodingAdditions

Retrieves the value of a property of the object at the end of the key path (a key path is a string of the form "key1.key2"). A key path has the form relationship.property (with one or more relationships); for example "movieRole.roleName" or "movieRole.talent.lastName". The default implementation of this method (provided by NSKeyValueCodingAdditions.DefaultImplementation) gets the destination object for each relationship using valueForKey, and returns the result of a valueForKey message to the final object.

Specified by:

valueForKeyPath in interface NSKeyValueCodingAdditions

Parameters:

keyPath - the keypath to evaluate

Returns:

the value for the derived property identified by keyPath

See Also:

NSKeyValueCoding.valueForKey(java.lang.String), NSKeyValueCodingAdditions.takeValueForKeyPath(java.lang.Object, java.lang.String), NSKeyValueCodingAdditions.DefaultImplementation

takeValueForKeyPath

public void takeValueForKeyPath(Object value,
                                String keyPath)

Description copied from interface: NSKeyValueCodingAdditions

Sets the value for the property identified by keyPath to value. A key path has the form relationship.property (with one or more relationships); for example "movieRole.roleName" or "movieRole.talent.lastName". The default implementation of this method (provided by NSKeyValueCodingAdditions.DefaultImplementation) gets the destination object for each relationship using valueForKey, and sends the final object a takeValueForKey message with value and property.

Specified by:

takeValueForKeyPath in interface NSKeyValueCodingAdditions

Parameters:

value - the property identified by keyPath is set to this

keyPath - identifies the property of an object

See Also:

NSKeyValueCoding.takeValueForKey(java.lang.Object, java.lang.String), NSKeyValueCodingAdditions.valueForKeyPath(java.lang.String), NSKeyValueCodingAdditions.DefaultImplementation