wt.enterprise
Interface FormActionDelegate

All Known Implementing Classes:

CheckInDocumentDelegate, CheckOutDelegate, CheckOutLFHDelegate, CreateDirServiceDelegate, CreateDirTranslationsDelegate, CreateDocumentDelegate, CreateIEServiceDelegate, CreateIETranslationsDelegate, DisableDelegate, EditFederatedServiceUrlsDelegate, EnableDelegate, FederationAdminDeleteDelegate, GetContentDelegate, SaveAsDocumentDelegate, SetConfigSpecDelegate, SetDocConfigSpecDelegate, SetProductInstanceConfigSpecDelegate, SubmitDelegate, UpdateDirServiceDelegate, UpdateDirTranslationsDelegate, UpdateIEServiceDelegate, UpdateIETranslationsDelegate, ViewTranslationsDelegate

public interface FormActionDelegate

Deprecation Notice: This class is still valid for this release, however this serves as advance notice that it will be removed in the future. All user interfaces built using the Windchill HTML Template Processing client architecture will be rewritten using a different framework in an upcoming release. This interface is what the FormProcessor uses as it's action delegate class for the invokeAction and processForm methods. This class could be implemented to make use of the FormProcessor funtionality. Note that the service.properties file needs to be updated if you want to do that

This class is actually only intended to be instantiated from the FormProcessor

Supported API: false

Extendable: false

Supported API: true

Extendable: false

See Also:

FormProcessor

Field Summary

static String

ACTION_OBJECT Deprecated.

Method Summary

Object	getActionObject() Deprecated.
Properties	processAction(Properties props, ContentHTTPStream contentStream, Locale locale) Deprecated.
void	setActionObject(Object a_ActionObject) Deprecated.

Field Detail

ACTION_OBJECT

public static final String ACTION_OBJECT

Deprecated.

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

Method Detail

getActionObject

public Object getActionObject()

Deprecated.

Gets the object for the association that plays role: ACTION_OBJECT.

Supported API: false

Returns:

Object

setActionObject

public void setActionObject(Object a_ActionObject)
                     throws WTPropertyVetoException

Deprecated.

Sets the object for the association that plays role: ACTION_OBJECT.

Supported API: false

Parameters:

a_ActionObject -

Throws:

WTPropertyVetoException

processAction

public Properties processAction(Properties props,
                                ContentHTTPStream contentStream,
                                Locale locale)
                         throws Exception

Deprecated.

This method will process an action invoked from the FormProcessor.

The Properties arguement will always contain name value pairs of those things based on the query string to the FormProcessor.

The contents of the Properties arguement is the based on the contents of the form when invoking the processForm method in the FormProcessor. It consists of the name value pairs up to the point of the beginning of content of the form. Then the rest of the form stream is placed in an instance of the ContentHttpStream class.

When invoking the invokeAction method in the FormProcessor class the ContentHttpStream arguement will always be null.

This method is intended to perform the action based on information pased. Any exception thrown will be displayed in the web browser to the user. It is best if the properties returned is a copy of the properties passed plus any

Supported API: false

Supported API: true

Parameters:

props -

contentStream -

locale -

Returns:

Properties

Throws:

Exception

See Also:

FormProcessor, wt.content.ContentHttpStream