com.sapportals.wcm.control.base

Class WcmResourceControl

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

All Implemented Interfaces:

com.sapportals.wdf.event.WdfEventReceiver

Direct Known Subclasses:

AddToFavoritesControl, ArchivingControl, BrokenLinkControl, CancelCheckoutControl, CloseControl, CollectionOrderControl, CreateCollectionControl, com.sapportals.wcm.control.fields.CSSControl, DemoPropertiesControl, ExternalLinkControl, ImageSelectControl, InternalLinkControl, LinkListControl, ModifyLinkControl, MultipleUploadControl, OrderedListEditorControl, OrganizeOrderedListControl, PropertiesControl, RemoteCancelCheckoutControl, RemoteClientSideEditControl, RemoteClientSideUploadControl, ResourceActionControl, ResourceCheckOutControl, ResourceClientSideDeleteControl, ResourceClientSideEditControl, ResourceClientSideOpenControl, ResourceClientSideUploadControl, ResourceCopyControl, ResourceCustomPropertyControl, ResourceCustomPropertyControl2, ResourceCustomPropertyServiceControl, ResourceDataTransferControl, ResourceDeleteControl, ResourceDetailsHeaderControl, ResourceEditControl, ResourceEditOnlineDescisionControl, ResourceEditTemplateControl, ResourceExtendedEditorControl, ResourceHeaderControl, ResourceHtmlEditControl, ResourceHtmlEditorControl, ResourceLinkControl, ResourceListControl, ResourceListControlOptions, ResourceLockControl, ResourceNewCollectionControl, ResourcePathControl, ResourcePreviewControl, ResourcePropertiesControl, ResourcePropertyControl, ResourceRevisionControl, ResourceSelectHelperControl, ResourceSetStatemanagementControl, ResourceSystemPropertyControl, ResourceTextEditorControl, ResourceTextEditorIDResolverControl, ResourceTimeBasedPublishingControl, ResourceTreeControlInternal, ResourceUploadControl, ResourceVersioningControl, SimpleServiceControl, TaxonomyControl, TemplateControl, TextInputRenderer

Deprecated. As of NetWeaver 7.1

public abstract class WcmResourceControl
extends WcmBaseControl
implements com.sapportals.wdf.event.WdfEventReceiver

Base Class to create reusable controls with WCM. All internally handled actions should be .setOnClick(ControlEventDispatcher.DISPATCH_EVENT);
The control IDs have to be generated using: ControlEventDispatcher.dispatchableControlID()
Classed deriving from this class need to implement a default constructor in order to be dynamically instanciated for events.

Nested Class Summary

protected class

WcmResourceControl.ResourceNotFoundException Deprecated. As of NetWeaver 7.1

Field Summary

String	START_PAGE_BROWSE Deprecated.
String	START_PAGE_DETAILS Deprecated.
protected String	uri Deprecated. current uri to the resource or list of resources

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

WcmResourceControl()
Deprecated.

Method Summary

protected boolean	checkArchivingStauts(IResource resource) Deprecated. Read archiving status for the given resource and check it.
protected com.sapportals.wcm.repository.service.archiving.AOStates	getAOStates(IResource resource) Deprecated.
protected IUriReference	getDetailsPageUri(RID rid, RID startRID) Deprecated. As of NetWeaver 7.1
IResource	getResource() Deprecated. As of NetWeaver 7.1
protected com.sapportals.htmlb.Link	getResourceLink(IResource resource, String url, String linkName, String displayName, String targetName) Deprecated. As of NetWeaver 7.1
IResourceList	getResourceList() Deprecated. As of NetWeaver 7.1
IResource	getSafeResource() Deprecated. As of NetWeaver 7.1
String	getUri() Deprecated. As of NetWeaver 7.1
void	receive(com.sapportals.wdf.event.WdfEvent event) Deprecated. As of NetWeaver 7.1
void	setResource(IResource aResource) Deprecated. As of NetWeaver 7.1
void	setUri(String uri) Deprecated. As of NetWeaver 7.1

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, readInputData, 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, initialize, initializeImpl, isInitialized, register, render, renderPersistentProperties, resetNestedControls, restorePersistentProperties, restoreProperties, setID, setInitialized, setParent, setStackId, triggerInput

Methods inherited from class java.lang.Object

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

Field Detail

START_PAGE_DETAILS

public final String START_PAGE_DETAILS

Deprecated.

See Also:

Constant Field Values

START_PAGE_BROWSE

public final String START_PAGE_BROWSE

Deprecated.

See Also:

Constant Field Values

uri

protected String uri

Deprecated.

current uri to the resource or list of resources

Constructor Detail

WcmResourceControl

public WcmResourceControl()

Deprecated.

Method Detail

setUri

public void setUri(String uri)

Deprecated. As of NetWeaver 7.1

sets the uri of the control. In case of a ";"-delimited uri string the list of resources is set *

getSafeResource

public IResource getSafeResource()
                          throws WcmException,
                                 WcmResourceControl.ResourceNotFoundException

Deprecated. As of NetWeaver 7.1

Doesn't return a null pointer. *

Throws:

WcmException

WcmResourceControl.ResourceNotFoundException

getResource

public IResource getResource()
                      throws WcmException

Deprecated. As of NetWeaver 7.1

Can be null! *

Throws:

WcmException

setResource

public void setResource(IResource aResource)
                 throws ResourceException

Deprecated. As of NetWeaver 7.1

Throws:

ResourceException

getResourceList

public IResourceList getResourceList()
                              throws WcmException

Deprecated. As of NetWeaver 7.1

Throws:

WcmException

getUri

public String getUri()

Deprecated. As of NetWeaver 7.1

receive

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

Deprecated. As of NetWeaver 7.1

reacts on CflResourceEvents and resets the present resource of the control. If controls want to implement a special treatment of these events they can implement this method themselves.

Specified by:

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

Throws:

com.sapportals.wdf.WdfException

getResourceLink

protected com.sapportals.htmlb.Link getResourceLink(IResource resource,
                                                    String url,
                                                    String linkName,
                                                    String displayName,
                                                    String targetName)
                                             throws WcmException

Deprecated. As of NetWeaver 7.1

Creates and returns a Link object referencing the specified resource. If url is specified, it will be used as reference. If url is null, the reference will be a concatenation of the content access path and the RID of the resource.

Parameters:

resource - the resource in question

url - the (encoded) URL of the resource (may be null)

linkName - the internal name of the Link object to be created

displayName - the name used for displaying the Link object (may be null)

targetName - the target used for the Link object (may be null)

Returns:

a HTMLB Link object pointing to the resource for accessing its content

Throws:

WcmException - if URL generator could not be retrieved

getDetailsPageUri

protected IUriReference getDetailsPageUri(RID rid,
                                          RID startRID)
                                   throws com.sapportals.wdf.WdfException

Deprecated. As of NetWeaver 7.1

Gets the relative URI to the details page showing information about the resource at rid.

Parameters:

rid - the RID of the resource in question

startRID - a RID restricting navigation in details page

Returns:

the relative URI reference to the details page

Throws:

com.sapportals.wdf.WdfException - on error

See Also:

IURLGeneratorService.getResourcePageUri(com.sapportals.wcm.service.urlgenerator.PathKey, com.sapportals.wcm.util.uri.RID, com.sapportals.wcm.util.uri.RID)

checkArchivingStauts

protected boolean checkArchivingStauts(IResource resource)

Deprecated.

Read archiving status for the given resource and check it. Return true if the status is Null (this means ALLOWED),ALLOWED,WAITING_APPROVAL,REJECTED and FORBIDDEN if the status is null(this is A in all other cases it's returns false. This method return true in case when "Archiving service" is deactivated.

getAOStates

protected com.sapportals.wcm.repository.service.archiving.AOStates getAOStates(IResource resource)

Deprecated.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[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