com.sap.portal.admin.wizard

Class AbstractPCMWizard

java.lang.Object
  com.sapportals.portal.prt.component.AbstractPortalComponent
      com.sapportals.admin.wizardframework.AbstractDynamicWizard
          com.sapportals.admin.wizardframework.templates.AbstractWizard
              com.sap.portal.admin.wizard.AbstractPCMWizard

All Implemented Interfaces:

IDynamicWizardConfigurator, IWizardConfigurator, IEventListenerComponent, IPortalComponent, IPortalComponentInit

Deprecated. Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).

public class AbstractPCMWizard
extends AbstractWizard

The class that represents a wizard for creating a PCD object.
The class provides methods for customizing the following:

• object data
• wizard summaries
• user interface strings
• the wizard flow

Extend this class to write a PCM wizard. The wizard adds the default panes and transitions, and enables you to add additional panes and transitions, or completely override the implementation.
In addition, this class enables finalizing the object before and after saving, handling the summaries, and overriding the default strings.

Nested Class Summary

static class

AbstractPCMWizard.InfoPaneInputKeys Deprecated. Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).

Field Summary

static String	BUNDLE_CUSTOMIZED_KEYS Deprecated. The session key for the strings that the wizard developer overrides.
protected static String	END_PANE Deprecated. A constant that defines the alias that points to a summary pane.
static String	META_ATTRIBUTE_DELIMITER Deprecated. A constant that defines the delimeter for meta attribute IDs.
protected static String	START_PANE Deprecated. A constant that defines the alias that points to an info pane.

Fields inherited from class com.sapportals.admin.wizardframework.AbstractDynamicWizard

BACK, CANCEL, FINISH, NEXT, PREV, STEP_NO_OFFSET, WIZARD_PARAMETERS

Constructor Summary

AbstractPCMWizard()
Deprecated. A blank constructor.

Method Summary

protected void	addDependencies(IConfigurableWizard wizard) Deprecated. Adds wizard dependencies.
protected void	addPanes(IConfigurableWizard wizard) Deprecated. Adds common panes to the wizard.
protected void	addTransitions(IConfigurableWizard wizard) Deprecated. Adds default transitions between common panes.
protected void	addUserPanes(IConfigurableWizard wizard) Deprecated. Adds user panes.
protected void	addUserTransitions(IConfigurableWizard wizard) Deprecated. Adds user transitions.
void	finalizeDescriptor(Map attributes, Object descriptor, IWizardContext context) Deprecated. Finalizes the descriptor before saving.
void	finalizeObject(IWizardContext context) Deprecated. Finalizes the new saved object.
void	finalizeObject(String newObjectId, IWizardContext context) Deprecated. Finalize the new saved object.
void	finalizeSummaries(Map summaries, IWizardContext context) Deprecated. Finalizes the summaries before they are displayed in the summary pane.
static PPLogger	getLogger() Deprecated.
void	initWizardSession(IWizardContext context) Deprecated. Initializes a wizard session.
protected void	setUIStrings(Map map) Deprecated. Overrides the common strings that are provided by the toolkit.
void	setupWizard(IConfigurableWizard wizard, IPortalComponentProfile profile, Map params, ResourceBundle languageResources) Deprecated. Configures the wizard.

Methods inherited from class com.sapportals.admin.wizardframework.AbstractDynamicWizard

doContent, processWizardParams

Methods inherited from class com.sapportals.portal.prt.component.AbstractPortalComponent

destroy, doAbout, doAfterContent, doBeforeContent, doComponentEvent, doEdit, doHandleEditData, doHelp, doOnNodeReady, doOnNodeRemove, doOnPOMReady, doPreview, doRefresh, doRequestEvent, getCacheDiscriminant, getCachingLevel, handleEvent, hasExpired, init, init, init, service

Methods inherited from class java.lang.Object

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

Field Detail

BUNDLE_CUSTOMIZED_KEYS

public static final String BUNDLE_CUSTOMIZED_KEYS

Deprecated.

The session key for the strings that the wizard developer overrides.

See Also:

Constant Field Values

META_ATTRIBUTE_DELIMITER

public static final String META_ATTRIBUTE_DELIMITER

Deprecated.

A constant that defines the delimeter for meta attribute IDs.

See Also:

Constant Field Values

START_PANE

protected static final String START_PANE

Deprecated.

A constant that defines the alias that points to an info pane.

See Also:

Constant Field Values

END_PANE

protected static final String END_PANE

Deprecated.

A constant that defines the alias that points to a summary pane.

See Also:

Constant Field Values

Constructor Detail

AbstractPCMWizard

public AbstractPCMWizard()

Deprecated.

A blank constructor.

Method Detail

initWizardSession

public void initWizardSession(IWizardContext context)

Deprecated.

Initializes a wizard session. Checks if there are any strings that the wizard developer should override, by calling setUIStrings(java.util.Map), and puts them in the session.

Specified by:

initWizardSession in interface IWizardConfigurator

Overrides:

initWizardSession in class AbstractDynamicWizard

Parameters:

context - the current wizard context

See Also:

IWizardConfigurator.initWizardSession(com.sapportals.admin.wizardframework.api.IWizardContext)

setupWizard

public void setupWizard(IConfigurableWizard wizard,
                        IPortalComponentProfile profile,
                        Map params,
                        ResourceBundle languageResources)

Deprecated.

Description copied from interface: IDynamicWizardConfigurator

Configures the wizard. The wizard does the following:

• Sets the wizard title.
• Adds panes to the IConfigurableWizard object.
• Sets the transitions between panes.
• Sets dependencies between data model objects.

Parameters:

wizard - the IConfigurableWizard instance used to set up the wizard

profile - the wizard profile

params - request parameters passed to the wizard

languageResources - a resource bundle for the requested locale

setUIStrings

protected void setUIStrings(Map map)

Deprecated.

Overrides the common strings that are provided by the toolkit. Each common pane encapsulates an inner class holding its user interface keys as constants. The key is taken from the pane. The value is your key, under which you override the default string.
For example, in order to override the string that asks the end-user for the next step after the wizard is finished (displayed in the last pane, after the object is saved), in your resource bundle add an entry with key = FINISH_QUESTION_STR, and the string. In the map that is passed as a parameter to this method, add the entry:
key = FinishPane.UiStrings.POST_COMPLETION_CHOICE_CAPTION_BUNDLE_KEY
value = FINISH_QUESTION_STR.

Parameters:

map - a map with the customized keys and values

finalizeSummaries

public void finalizeSummaries(Map summaries,
                              IWizardContext context)

Deprecated.

Finalizes the summaries before they are displayed in the summary pane. The summaries map holds the summaries that were registered.
Each entry in this map holds a string as a key (the attribute/meta-attribute ID), and a Pair instance as a value. The Pair instance holds the summary caption, and the attribute value. The summaries that are registered by the user are held as {String, Pair} entries. The summary pane looks for the value's friendly name for those entries, using the PropertyEditor API. The developer can modify the entries and/or add entries:
First, look for the key with the required attribute ID. There are several options to modify the value:

• Change the value (caption, value), but keep it as a pair. The map entry would be {String, Pair}. The summary pane looks for the value's friendly name.
• Change the value and put a string as the value in the map. The map entry would be {String, String}. The summary pane puts the summary entry into the map as is (it assumes that the final value is put in the map).
• Change the value and put a list as the value in the map. The map entry would be {String, List}. The summary pane puts in an entry with one caption and multiple values (it assumes that the final values are in the map).

For example:

 //override the summary value, keeping the entry value as a pair.
 if (summaries.containsKey("MyAttributeId")) {
                Pair valPair = (Pair)summaries.get("MyAttributeId");
                String caption = (String)valPair.getFirst();
                summaries.put("MyAttributeId", new Pair(caption, "MySummaryValue");
 }
 

The summary name can also be modified from the pane, using the service API: IBasicObjectCreationService.setSummaryCaption(java.lang.String, java.lang.String, com.sapportals.admin.wizardframework.api.IWizardContext)

Parameters:

summaries - summaries map

context - the current wizard context

See Also:

IBasicObjectCreationService.setComponentAsAttribute(com.sapportals.admin.wizardframework.components.AbstractInputComponent, java.lang.String, boolean, com.sapportals.admin.wizardframework.api.IWizardContext)

finalizeDescriptor

public void finalizeDescriptor(Map attributes,
                               Object descriptor,
                               IWizardContext context)

Deprecated.

Finalizes the descriptor before saving. Puts the attributes that were registered by the developer into the descriptor using IBasicObjectCreationService.setComponentAsAttribute(com.sapportals.admin.wizardframework.components.AbstractInputComponent, java.lang.String, boolean, com.sapportals.admin.wizardframework.api.IWizardContext) It can be overriden in order to add or modify attributes.
There are two ways to add or modify attributes:

• Put the attributes directly into the descriptor. These attributes should not have entries in the map, because the super implementation reads everything from the map. The descriptor can be cast to the semantic descriptor to perform additional actions.
• Put/modify attributes in the map. In this case they are automatically put into the descriptor by the super implementation.

The overriding method must call super.finalizeDescriptor to automatically copy attributes from the map into the descriptor, and to handle common attributes (for example, title, description, locale) registered by the info pane.
The method assumes that the descriptor is an instance of INewObjectDescriptor, therefore it does not support other types of descriptors.
Important: The object is always created as a non-template object. Therefore, if the descriptor is not of INewObjectDescriptor type, you need to handle this attribute.
For example:

        descriptor.putAttribute(IAttrPcmGeneral.ATTRIBUTE_IS_TEMPLATE, "false");
 

Parameters:

descriptor - an object descriptor

attributes - a map containing attributes

context - the current wizard context

Throws:

DescriptorNotCreatedException - if the descriptor is not an instance of INewObjectDescriptor

finalizeObject

public void finalizeObject(IWizardContext context)

Deprecated.

Finalizes the new saved object.

Parameters:

context - the current wizard context

finalizeObject

public void finalizeObject(String newObjectId,
                           IWizardContext context)

Deprecated.

Finalize the new saved object. In order to get the semantic object, perform a lookup of the semantic object.

Parameters:

newObjectId - the id of the new object that was created. It should be used for loading the object.

context - wizard context.

addPanes

protected void addPanes(IConfigurableWizard wizard)

Deprecated.

Adds common panes to the wizard. Add custom panes in the addUserPanes(com.sapportals.admin.wizardframework.api.IConfigurableWizard) implementation in the wizard. Another option is to completely override this method for all the panes.
Note: To add arguments to one of the common panes, it is not necessary to override this method. Instead, add the pane with the required arguments in the addUserPanes(com.sapportals.admin.wizardframework.api.IConfigurableWizard) implementation, overriding the previous instance of the pane.

Parameters:

wizard - the running wizard

addUserPanes

protected void addUserPanes(IConfigurableWizard wizard)

Deprecated.

Adds user panes. Override this method to add your own panes. The default implementation adds common panes.

Parameters:

wizard - the running wizard

addTransitions

protected void addTransitions(IConfigurableWizard wizard)

Deprecated.

Adds default transitions between common panes. Does not add transitions between user panes. User pane transitions must be added in the addUserTransitions(com.sapportals.admin.wizardframework.api.IConfigurableWizard) implementation, or by overriding this method with a complete set of transitions.

Parameters:

wizard - the running wizard

addUserTransitions

protected void addUserTransitions(IConfigurableWizard wizard)

Deprecated.

Adds user transitions. Override this method to add your own transitions. The default implementation adds transitions between the info pane and the summary pane.

Parameters:

wizard - the running wizard

addDependencies

protected void addDependencies(IConfigurableWizard wizard)

Deprecated.

Adds wizard dependencies.

Parameters:

wizard - the running wizard

getLogger

public static PPLogger getLogger()

Deprecated.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/admin/api	api	EP-PIN