com.sapportals.wcm.control.edit

Class ResourceCustomPropertyServiceControl

java.lang.Object
  com.sapportals.wdf.stack.Control
      com.sapportals.wcm.control.base.WcmBaseControl
          com.sapportals.wcm.control.base.WcmResourceControl
              com.sapportals.wcm.control.edit.ResourceCustomPropertyServiceControl

All Implemented Interfaces:

com.sapportals.wdf.event.WdfEventReceiver

public class ResourceCustomPropertyServiceControl
extends WcmResourceControl
implements com.sapportals.wdf.event.WdfEventReceiver

User interface for creation and modification of custom properties.

Nested Class Summary

Nested classes/interfaces inherited from class com.sapportals.wcm.control.base.WcmResourceControl

WcmResourceControl.ResourceNotFoundException

Field Summary

Fields inherited from class com.sapportals.wcm.control.base.WcmResourceControl

START_PAGE_BROWSE, START_PAGE_DETAILS, uri

Fields inherited from class com.sapportals.wcm.control.base.WcmBaseControl

BLANK_LINK_TARGET, CELL_PADDING_STANDARD, CELL_SPACING_STANDARD, CONTROL_HEADER_STANDARD, DETAILS_CONFIG_FILE, NONE, RES_BUTTON_ADD, RES_BUTTON_APPLY, RES_BUTTON_BACK, RES_BUTTON_CANCEL, RES_BUTTON_CLOSE, RES_BUTTON_LOAD, RES_BUTTON_MORE, RES_BUTTON_OK, RES_BUTTON_REMOVE, RES_BUTTON_SAVE, RES_BUTTON_SELECT, RES_BUTTON_UPDATE, resourceContext, SUMMARY

Fields inherited from class com.sapportals.wdf.stack.Control

id

Constructor Summary

ResourceCustomPropertyServiceControl()

Method Summary

boolean	canSave() Workaround for composite control usage.
ArrayList	getProperties() Returns local property map.
String	getSelectedMetaValueId() Get the SelectedMetaValueId attribute of the ResourceCustomPropertyServiceControl object.
IPropertyConfigurationService	getService() Get the Service attribute of the ResourceCustomPropertyServiceControl object.
boolean	getShowSaveButton() Get the ShowSaveButton attribute of the ResourceCustomPropertyServiceControl object.
protected void	initialize() Initialize control by making a copy of data from resource.
boolean	isServiceSupported() True, if service is available and configured meta names available.
com.sapportals.wdf.event.WdfEvent	onSave(com.sapportals.htmlb.event.Event event) Save all changes to resource.
protected void	readInputData() Reads data from dynPage.
void	receive(com.sapportals.wdf.event.WdfEvent wdfEvent) Receives WDF events.
com.sapportals.htmlb.Component	render() Renders control.
com.sapportals.htmlb.Component	renderPersistentProperties() Renders local properties map as hidden InputField.
void	restorePersistentProperties(com.sapportals.htmlb.page.DynPage page) Restores local properties map as hidden InputField.
void	setSelectedMetaNameId(String selectedMetaNameId) Set the SelectedMetaNameId attribute of the ResourceCustomPropertyServiceControl object.
void	setSelectedMetaValueId(String selectedMetaValueId) Set the SelectedMetaValueId attribute of the ResourceCustomPropertyServiceControl object.
void	setShowSaveButton(boolean showSaveButton) Set the ShowSaveButton attribute of the ResourceCustomPropertyServiceControl object.

Methods inherited from class com.sapportals.wcm.control.base.WcmResourceControl

checkArchivingStauts, getAOStates, getDetailsPageUri, getResource, getResourceLink, getResourceList, getSafeResource, getUri, setResource, setUri

Methods inherited from class com.sapportals.wcm.control.base.WcmBaseControl

getBaseBundleString, getBaseBundleString, getBaseBundleString, getBaseBundleString, getBundleString, getBundleString, getBundleString, getBundleString, getBusinessCardLink, getImage, getParameterConfiguration, getResourceContext, getServicePageUri, handleException, isSection508Rendering, isTestMode, isVisible, setControlContext, setResourceContext, setTestMode, setVisible

Methods inherited from class com.sapportals.wdf.stack.Control

create, create, createNestedControls, createUnequivocallyComponentId, dispatchHtmlbEvent, dispatchWdfEvent, getControlContext, getDynPage, getID, getParent, getPersistenceComponentManager, getRootControl, getStackId, initializeImpl, isInitialized, register, resetNestedControls, restoreProperties, setID, setInitialized, setParent, setStackId, triggerInput

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceCustomPropertyServiceControl

public ResourceCustomPropertyServiceControl()

Method Detail

setShowSaveButton

public void setShowSaveButton(boolean showSaveButton)

Set the ShowSaveButton attribute of the ResourceCustomPropertyServiceControl object.

Parameters:

showSaveButton - The new ShowSaveButton value

setSelectedMetaNameId

public void setSelectedMetaNameId(String selectedMetaNameId)

Set the SelectedMetaNameId attribute of the ResourceCustomPropertyServiceControl object.

Parameters:

selectedMetaNameId - The new SelectedMetaNameId value

setSelectedMetaValueId

public void setSelectedMetaValueId(String selectedMetaValueId)

Set the SelectedMetaValueId attribute of the ResourceCustomPropertyServiceControl object.

Parameters:

selectedMetaValueId - The new SelectedMetaValueId value

getSelectedMetaValueId

public String getSelectedMetaValueId()

Get the SelectedMetaValueId attribute of the ResourceCustomPropertyServiceControl object.

Returns:

The SelectedMetaValueId value

getShowSaveButton

public boolean getShowSaveButton()

Get the ShowSaveButton attribute of the ResourceCustomPropertyServiceControl object.

Returns:

The ShowSaveButton value

getProperties

public ArrayList getProperties()

Returns local property map.

Returns:

The local modified property array.

getService

public IPropertyConfigurationService getService()
                                         throws ResourceException

Get the Service attribute of the ResourceCustomPropertyServiceControl object.

Returns:

- The Service value

Throws:

ResourceException - Exception raised in failure situation

canSave

public boolean canSave()
                throws WcmException

Workaround for composite control usage.

Returns:

a command state

Throws:

WcmException - Exception raised in failure situation

receive

public void receive(com.sapportals.wdf.event.WdfEvent wdfEvent)
             throws com.sapportals.wdf.WdfException

Receives WDF events.

Specified by:

receive in interface com.sapportals.wdf.event.WdfEventReceiver

Overrides:

receive in class WcmResourceControl

Parameters:

wdfEvent -

Throws:

com.sapportals.wdf.WdfException - Exception raised in failure situation TODO: Description of the incoming method parameter

isServiceSupported

public boolean isServiceSupported()
                           throws WcmException

True, if service is available and configured meta names available.

Returns:

The result.

Throws:

WcmException - Exception raised in failure situation

render

public com.sapportals.htmlb.Component render()
                                      throws com.sapportals.wdf.WdfException

Renders control.

Specified by:

render in class com.sapportals.wdf.stack.Control

Returns:

A sub component tree.

Throws:

com.sapportals.wdf.WdfException - An error happens.

onSave

public com.sapportals.wdf.event.WdfEvent onSave(com.sapportals.htmlb.event.Event event)
                                         throws com.sapportals.wdf.WdfException

Save all changes to resource.

Parameters:

event - A htmlb event.

Returns:

A ScreenFlow event.

Throws:

com.sapportals.wdf.WdfException - An error happens.

restorePersistentProperties

public void restorePersistentProperties(com.sapportals.htmlb.page.DynPage page)
                                 throws com.sapportals.wdf.WdfException

Restores local properties map as hidden InputField.

Overrides:

restorePersistentProperties in class com.sapportals.wdf.stack.Control

Parameters:

page - The DynPage to read out components

Throws:

com.sapportals.wdf.WdfException

renderPersistentProperties

public com.sapportals.htmlb.Component renderPersistentProperties()
                                                          throws com.sapportals.wdf.WdfException

Renders local properties map as hidden InputField.

Overrides:

renderPersistentProperties in class com.sapportals.wdf.stack.Control

Returns:

A sub control tree containing hidden fields.

Throws:

com.sapportals.wdf.WdfException

initialize

protected void initialize()
                   throws com.sapportals.wdf.WdfException

Initialize control by making a copy of data from resource.

Overrides:

initialize in class com.sapportals.wdf.stack.Control

Throws:

com.sapportals.wdf.WdfException

readInputData

protected void readInputData()
                      throws com.sapportals.wdf.WdfException

Reads data from dynPage.

Overrides:

readInputData in class WcmBaseControl

Throws:

com.sapportals.wdf.WdfException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/nonwduideprecated	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM