com.sapportals.wcm.control.navigation

Class ArchivingControl

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

All Implemented Interfaces:

com.sapportals.wdf.event.WdfEventReceiver

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

This control take a possibility to the user to mark for archiving given resource. This happen only in the cases when the document isn't marked yet and when the approval is enable for this resource.

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

ArchivingControl()
Default Constructor

ArchivingControl(String controlID)
Constructor with ConstrolID

Method Summary

boolean	getSendBackEvent() Gets the sendBackEvent attribute of the ResourceSetStatemanagementControl object
boolean	isApprovalActive()
com.sapportals.wdf.event.WdfEvent	onCancel(com.sapportals.htmlb.event.Event event) Description of the Method
com.sapportals.wdf.event.WdfEvent	onCancelApproval(com.sapportals.htmlb.event.Event event) Handle method for button 'CancelApproval'
com.sapportals.wdf.event.WdfEvent	onForceApproval(com.sapportals.htmlb.event.Event event) Handle method for button 'ForceApproval'
com.sapportals.wdf.event.WdfEvent	onMark(com.sapportals.htmlb.event.Event event) Mark the resource and its children if the resource is collection
com.sapportals.wdf.event.WdfEvent	onUnMark(com.sapportals.htmlb.event.Event event) Handlermethod for button 'UnMark'
void	readInputData()
void	receive(com.sapportals.wdf.event.WdfEvent impEvent) Description of the Method
com.sapportals.htmlb.Component	render() renderes the complete Control
void	setSendBackEvent(boolean flag) Sets the sendBackEvent attribute of the ResourceSetStatemanagementControl 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, initialize, initializeImpl, isInitialized, register, 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

Constructor Detail

ArchivingControl

public ArchivingControl()
                 throws WcmException

Default Constructor

Throws:

WcmException - Exception raised in failure situation

ArchivingControl

public ArchivingControl(String controlID)
                 throws WcmException

Constructor with ConstrolID

Parameters:

controlID - Description of the param

Throws:

WcmException - Exception raised in failure situation

Method Detail

render

public com.sapportals.htmlb.Component render()

renderes the complete Control

Specified by:

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

Returns:

Description of the Return Value

onMark

public com.sapportals.wdf.event.WdfEvent onMark(com.sapportals.htmlb.event.Event event)

Mark the resource and its children if the resource is collection

Parameters:

event - Description of the param

Returns:

Description of the Return Value

onUnMark

public com.sapportals.wdf.event.WdfEvent onUnMark(com.sapportals.htmlb.event.Event event)

Handlermethod for button 'UnMark'

Parameters:

event - Description of the param

Returns:

Description of the Return Value

onCancelApproval

public com.sapportals.wdf.event.WdfEvent onCancelApproval(com.sapportals.htmlb.event.Event event)

Handle method for button 'CancelApproval'

Parameters:

event - Description of the param

Returns:

Description of the Return Value

onForceApproval

public com.sapportals.wdf.event.WdfEvent onForceApproval(com.sapportals.htmlb.event.Event event)

Handle method for button 'ForceApproval'

Parameters:

event - Description of the param

Returns:

Description of the Return Value

onCancel

public com.sapportals.wdf.event.WdfEvent onCancel(com.sapportals.htmlb.event.Event event)
                                           throws WcmException

Description of the Method

Parameters:

event - Description of the param

Returns:

Description of the Return Value

Throws:

WcmException - Exception raised in failure situation

readInputData

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

Overrides:

readInputData in class WcmBaseControl

Throws:

com.sapportals.wdf.WdfException

receive

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

Description of the Method

Specified by:

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

Overrides:

receive in class WcmResourceControl

Parameters:

impEvent - Description of the param

Throws:

com.sapportals.wdf.WdfException - Exception raised in failure situation

setSendBackEvent

public void setSendBackEvent(boolean flag)

Sets the sendBackEvent attribute of the ResourceSetStatemanagementControl object

Parameters:

flag - The new sendBackEvent value

getSendBackEvent

public boolean getSendBackEvent()

Gets the sendBackEvent attribute of the ResourceSetStatemanagementControl object

Returns:

The sendBackEvent value

isApprovalActive

public boolean isApprovalActive()
                         throws WcmException

Throws:

WcmException

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