com.sap.workspaces.authoring

Interface IWriteProtectMode

All Superinterfaces:
IWorkspacesService

public interface IWriteProtectMode
extends IWorkspacesService

For maintenance purposes, the portal periodically goes into write-protect mode. Use this interface to check if the portal is in write-protect mode, and ensure proper execution of write operations.

Since:
1.1

Field Summary
static String WRITEPROTECT_MODE_EXCEPTION
           
 
Method Summary
 void assertWriteProtectOff()
          Throws a runtime exception if the PCD is in write-protect mode; call this method if you want to handle this exception
 boolean isWriteProtectMode()
          Checks whether the PCD is in write-protect mode
 

Field Detail

WRITEPROTECT_MODE_EXCEPTION

static final String WRITEPROTECT_MODE_EXCEPTION
See Also:
Constant Field Values
Method Detail

isWriteProtectMode

boolean isWriteProtectMode()
Checks whether the PCD is in write-protect mode

Returns:
True if the PCD is in write-protect mode

assertWriteProtectOff

void assertWriteProtectOff()
                           throws WorkspacesRuntimeException
Throws a runtime exception if the PCD is in write-protect mode; call this method if you want to handle this exception

Throws:
An - exception if the PCD is in write-protect mode
WorkspacesRuntimeException


Copyright 2011 SAP AG Complete Copyright Notice