com.sap.portal.admin.wizard

Interface IBasicObjectCreationService

Deprecated.

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

public interface IBasicObjectCreationService

The interface that provides methods for the creation of a new semantic object in the PCD. Each wizard that creates a semantic object must implement this class.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY Deprecated. The service key.

Method Summary

Modifier and Type	Method and Description
Map	getAttributes2SummariesMap(IWizardContext context) Deprecated. Returns a map of attributes.
String	getAttributeValueFromTarget(String attrId, IWizardContext context) Deprecated. Gets an attribute value from the target object (template or portal component).
String	getBundleString(String key, IWizardContext context) Deprecated. Gets a string from the resource bundle.
String	getCreateModeParam(IWizardContext context) Deprecated. Gets the object's oClass parameter from the Portal Catalog, indicating whether it is based on a template or a PAR.
String	getDefaultHandlerKey(IWizardContext context) Deprecated. Internal use.
String	getEditorIdParam(IWizardContext context) Deprecated. Gets the editor ID (editorID) parameter from the Portal Catalog.
String	getMetaAttributeValueFromTarget(String attrId, String metaAttrId, IWizardContext context) Deprecated. Gets a meta-attribute value from the target object (template or portal component).
String	getObjectTypeParam(IWizardContext context) Deprecated. Gets the new object's component type (ComponentType or com.sap.portal.ComponentType) parameter from the Portal Catalog.
String	getSaveLocationParam(IWizardContext context) Deprecated. Gets the object's save location (where) parameter from the Portal Catalog.
String	getTargetIdParam(IWizardContext context) Deprecated. Gets the target object ID (what) parameter from the Portal Catalog.
boolean	isInHouseMode() Deprecated. Internal use.
void	setComponentAsAttribute(AbstractInputComponent component, String attrId, boolean addAsSummary, IWizardContext context) Deprecated. Sets the specified component's value to be an attribute for the object.
void	setFinishMessage(FinishPane.FinishMessageType messageType, String messageKey, IWizardContext context) Deprecated. Sets the type of message to be displayed above the FinishPane when the wizard finishes.
void	setSummaryCaption(String attrId, String caption, IWizardContext context) Deprecated. Sets the summary caption resource bundle key.

Field Detail

KEY

static final String KEY

Deprecated.

The service key.

See Also:

Constant Field Values

Method Detail

getBundleString

String getBundleString(String key,
                       IWizardContext context)

Deprecated.

Gets a string from the resource bundle. First, it looks for the key in the local resource bundle (taken from the request). If the key is not found, it looks in the object's default wizard resource bundle, and finally it looks for the string in the toolkit's common resource bundle.
For example, suppose the implemented wizard is designed to create an iView. It defines its own resource bundle with various strings specific to the wizard implementation. In addition, it uses the toolkit's common panes. There are three possible scenarios when requesting strings:

• Requesting a string which is specific for this wizard. The string exists only in the wizard's resource bundle, and is fetched from there.
• Requesting a string that is not specific to this wizard, but is general for iView wizards (for example iView Name). It therefore exists in the resource bundle of the default iView wizard.
  Note: The toolkit's common panes automatically requests common strings.
  
• Requesting a general string that is not specific for any type of object. It therefore exists in the toolkit's resource bundle, and is fetched from there (for example, close the wizard).

Parameters:

key - a key

context - the current wizard context

Returns:

the translated string, if not found returns the key

getAttributeValueFromTarget

String getAttributeValueFromTarget(String attrId,
                                   IWizardContext context)

Deprecated.

Gets an attribute value from the target object (template or portal component). If the attribute is of type text, it returns the value according to the target's locale. If the target has no locale definition, the portal locale is used.

Parameters:

attrId - an attribute ID

context - the current wizard context

Returns:

the attribute value, null if the attribute ID is invalid or the attribute does not exist

See Also:

IAttributes.getAttribute(String)

getMetaAttributeValueFromTarget

String getMetaAttributeValueFromTarget(String attrId,
                                       String metaAttrId,
                                       IWizardContext context)

Deprecated.

Gets a meta-attribute value from the target object (template or portal component). If it is a meta-attribute of type text, it returns the value according to the target's locale. If the target has no locale definition, the portal locale is used.

Parameters:

attrId - an attribute ID

metaAttrId - a meta-attribute ID

context - the current wizard context

Returns:

the meta-attribute value, null if the meta-attribute ID is invalid or the meta-attribute does not exist

See Also:

IAttributes.getMetaAttribute(String, String)

setComponentAsAttribute

void setComponentAsAttribute(AbstractInputComponent component,
                             String attrId,
                             boolean addAsSummary,
                             IWizardContext context)

Deprecated.

Sets the specified component's value to be an attribute for the object. This creates an automatic link between the user interface control and the object attribute. Generally the attribute ID is provided. If the ID has a '-' delimiter, it indicates a meta-attribute. For text attributes, the toolkit identifies it by getting the attribute type from the PCM.

Parameters:

component - a user interface component

attrId - an attribute ID

addAsSummary - if true, displays this component in the summary view

context - the current wizard context

setSummaryCaption

void setSummaryCaption(String attrId,
                       String caption,
                       IWizardContext context)

Deprecated.

Sets the summary caption resource bundle key. The specified key is translated in the summary pane.

Parameters:

attrId - an attribute ID

caption - a caption to be displayed as the summary name

context - the current wizard context

See Also:

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

getAttributes2SummariesMap

Map getAttributes2SummariesMap(IWizardContext context)

Deprecated.

Returns a map of attributes. The map holds the following entries:
Key = attribute ID (String), value = Pair{summary caption, value}
The map holds all the components that were registered using the method setComponentAsAttribute(com.sapportals.admin.wizardframework.components.AbstractInputComponent, java.lang.String, boolean, com.sapportals.admin.wizardframework.api.IWizardContext)

Parameters:

context - the current wizard context

Returns:

the map

setFinishMessage

void setFinishMessage(FinishPane.FinishMessageType messageType,
                      String messageKey,
                      IWizardContext context)

Deprecated.

Sets the type of message to be displayed above the FinishPane when the wizard finishes.

Parameters:

messageType - the type of message to be displayed

messageKey - bundle key of string to be displayed.

context - wizard context

See Also:

FinishPane.FinishMessageType

getDefaultHandlerKey

String getDefaultHandlerKey(IWizardContext context)

Deprecated.

Internal use.
Do not use. Gets the service key of the API handler that is implemented for the provided object type.

Parameters:

context - the current wizard context

Returns:

the handler service key

getSaveLocationParam

String getSaveLocationParam(IWizardContext context)

Deprecated.

Gets the object's save location (where) parameter from the Portal Catalog.

Parameters:

context - the current wizard context

Returns:

the save location

getTargetIdParam

String getTargetIdParam(IWizardContext context)

Deprecated.

Gets the target object ID (what) parameter from the Portal Catalog.

Parameters:

context - the current wizard context

Returns:

the target ID, null if the object has no target

getObjectTypeParam

String getObjectTypeParam(IWizardContext context)

Deprecated.

Gets the new object's component type (ComponentType or com.sap.portal.ComponentType) parameter from the Portal Catalog.

Parameters:

context - the current wizard context

Returns:

the object type, null if it does not exist

getCreateModeParam

String getCreateModeParam(IWizardContext context)

Deprecated.

Gets the object's oClass parameter from the Portal Catalog, indicating whether it is based on a template or a PAR.

Parameters:

context - the current wizard context

Returns:

the create mode, null if it does not exist

getEditorIdParam

String getEditorIdParam(IWizardContext context)

Deprecated.

Gets the editor ID (editorID) parameter from the Portal Catalog.

Parameters:

context - the current wizard context

Returns:

the editor ID

isInHouseMode

boolean isInHouseMode()

Deprecated.

Internal use. Checks the translation mode.

Returns:

true for internal mode, false if not