com.novell.emframe.dev

Class VetoCreatorTask

java.lang.Object

com.novell.nps.gadgetManager.BaseGadgetInstance

com.novell.emframe.fw.legacySupport.LegacyTaskImpl

com.novell.emframe.dev.Task

com.novell.emframe.dev.VetoCreatorTask

All Implemented Interfaces:

com.novell.emframe.fw.legacySupport.LegacyTask, com.novell.nps.configManager.ConfigurationComplete, com.novell.nps.gadgetManager.GadgetInstance, java.io.Serializable

public class VetoCreatorTask
extends Task

Generic Creator Task that will Veto any object creation operation. Allow the ability for plugins to veto some type of object creation. Simply register the VetoCreatorClass as an object-creator to veto generic object creation.

In this example we have "Print Server" object.
<plugins>
<object-creator>
<id>dev.vetoPrintserverCreate</id>
<object-type-name>Print Server</object-type-name>
<version>1.0</version>
<required-version>1.0</required-version>
<class-name>com.novell.emframe.dev.VetoCreatorTask</class-name>
</object-creator>
</plugins>

<id>dev.vetoPrintserverCreate</id> is the id of your new task which can be anything.
<object-type-name>Print Server</object-type-name> is the object type you want the creation to be vetoed for.
<class-name>com.novell.emframe.dev.VetoCreatorTask</class-name> is the generic veto class that every plug-in could use or you can create your own.

The above XML piece should be added in the plugin directory for each product for the desired object type. The XML file can be named anything.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HTMLPARAM_SELECTEDCLASS HTMLPARAM_SELECTEDCLASS = "SelectedClass".
static java.lang.String	HTMLPARAM_TRANSLATEDCLASS HTMLPARAM_TRANSLATEDCLASS = "TranslatedClass".

Fields inherited from class com.novell.emframe.dev.Task

initialized, nextTaskExtraParameters, NOT_CHANGED, onCancelString, onCompleteString, repeatParams, res, taskCompleteFlag

Fields inherited from class com.novell.nps.gadgetManager.BaseGadgetInstance

CONFIGURABLE, gadgetAssignment, gadgetAssignmentDN, gadgetCode, gadgetInstanceID, GETDATA, HANDLE_ACTION_ERROR_STATE, helpURL, m_doc, m_JSPDataObject, m_moduleStylesheet, m_previousState, myLocale, PROCESSREQUEST, repeatable, resBundle, session, state, STATE_SHOW_USER_CONFIG, STATE_USER_CONFIG_COMPLETE, windowState

Fields inherited from interface com.novell.nps.gadgetManager.GadgetInstance

FULLPAGE_BRANDING_AREA_MODE, FULLPAGE_DATA_MODE, FULLPAGE_REQUEST_PROPERTY, GADGET_DN, GADGET_INSTANCE_ARGS, GADGET_INSTANCE_CLASS, GADGET_INSTANCE_ID_PROPERTY, LAUNCH_TYPE_DELEGATE, LAUNCH_TYPE_LAUNCH, LIFECYCLE_TYPE_EXISTING, LIFECYCLE_TYPE_NEW, LIFECYCLE_TYPE_RECREATE, LIFECYCLE_TYPE_RESET, LIFECYCLE_TYPE_REUSE, PARAM_RETURN_STATUS, RETURN_STATUS_CANCEL, RETURN_STATUS_CANCEL_ABORT, RETURN_STATUS_CANCEL_CONTINUE, RETURN_STATUS_ERROR_ABORT, RETURN_STATUS_ERROR_CONTINUE, RETURN_STATUS_FINISHED, STATE_PROPERTY, TEXT_HTML, TEXT_XML, WINDOW_STATE_MAXIMIZED, WINDOW_STATE_MINIMIZED

Constructor Summary

Constructors

Constructor and Description
VetoCreatorTask()

Method Summary

Modifier and Type	Method and Description
boolean	execute(TaskContext context, java.util.Properties resultStrings) Main method of the plugin.

Methods inherited from class com.novell.emframe.dev.Task

addAllUrlParams, buildQueryString, execute, execute, getParameter, getUIPage, init, init, isInitialized, isPluginAvailable, release, setInitialized, setUIPage, shouldRun

Methods inherited from class com.novell.emframe.fw.legacySupport.LegacyTaskImpl

getDocument, getJSPDataObjectOrNull, getLegacyTaskInfo, getRepeatParams, getTaskId, setRepeatable

Methods inherited from class com.novell.nps.gadgetManager.BaseGadgetInstance

addActionListener, callGetData, clearDocument, configureApply, configureCancel, configureComplete, createDocument, findURIForLocFile, getAction, getActionIcons, getAllowProcessRequestAsync, getConfig, getConfigObjectSetting, getConfigObjectSettings, getConfigSetting, getConfigSetting, getConfigSettings, getConfigSettingValue, getConfigSettingValues, getConfiguredUniqueID, getContainedGadgetInstanceStylesheets, getCustomizeQueryString, getData, getDataFromLastTry, getFullPageMode, getGadgetAssignment, getGadgetAssignmentDN, getGadgetInstanceID, getGadgetXMLEndTag, getGadgetXMLStartTag, getHandleActionErrorStateData, getIntConfigSetting, getJSPDataObject, getJSPPage, getLangResourceURI, getLaunchType, getLifeCycleType, getLocale, getLocHelpURL, getLocResourceURI, getManagementServiceSet, getOriginalServiceName, getParam, getParentInstance, getPortalConnection, getPreferredDataType, getPreferredName, getPreferredName, getPrimary, getProxyServer, getRedirectionOrSelf, getResourceBundle, getResourcePathBase, getReturnStatus, getRootDelegator, getRootNodeName, getSession, getState, getStylesheetAndResourceSets, getStyleSheetName, getUserConfigCompleteData, getWindowState, handleAction, handlePostRequestActions, hasHelp, init, isConfigSettingCumulative, isConfigSettingOverwriteable, isForceRead, isTimedOut, onPageMaximize, onPageMinimize, onPortalInit, onShowUserConfigAction, onUserConfigCompleteAction, outputHTMLError, parseMultipartFormData, prepare, processRequest, processRequest, processSecondaryGadgetResults, removeActionListener, reset, returnToPrimary, setAllowProcessRequestAsync, setConfigSetting, setConfigSetting, setForceRead, setGadgetAssignment, setGadgetAssignmentDN, setGadgetInstanceID, setGetDataFromLastTry, setLaunchType, setLifeCycleType, setLocale, setModuleStylesheet, setParentInstance, setPrimary, setRedirectionOrSelf, setRepeatParams, setRequestedDataType, setResourceBundle, setRootDelegator, setSession, setState, setTimedOut, setWindowState, supportsDeviceCharacteristics, writeConfig, writeGadgetXMLEndTag, writeGadgetXMLStartTag

Methods inherited from class java.lang.Object

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

Field Detail

HTMLPARAM_SELECTEDCLASS

public static final java.lang.String HTMLPARAM_SELECTEDCLASS

HTMLPARAM_SELECTEDCLASS = "SelectedClass".

See Also:

Constant Field Values

HTMLPARAM_TRANSLATEDCLASS

public static final java.lang.String HTMLPARAM_TRANSLATEDCLASS

HTMLPARAM_TRANSLATEDCLASS = "TranslatedClass".

See Also:

Constant Field Values

Constructor Detail

VetoCreatorTask

public VetoCreatorTask()

Method Detail

execute

public boolean execute(TaskContext context,
                       java.util.Properties resultStrings)

Main method of the plugin.

Specified by:

execute in class Task

Parameters:

context - TaskContext of the plug-in

resultStrings - Properties object to use to add parameters to the HttpServletRequest.

Returns:

boolean: true if execution was successful, false if otherwise

See Also:

Task.init(TaskContext, Document), Task.setUIPage(java.lang.String), TaskContext, eMFrameUtils