Skip navigation links


com.essbase.eas.essbase.server.outline
Class CommandBox

java.lang.Object
  extended by com.essbase.eas.essbase.server.outline.CommandBox

Direct Known Subclasses:
ViewCommandBox

public class CommandBox
extends java.lang.Object

implements a "box" for organizing outline command handling.

Since:
6.5.1
Version:
6.5.4
Author:
Hank Cox

Field Summary
protected  Identifier identifier
           
protected  EditorLogic logic
           
protected  boolean oktogo
           
protected  ServiceContext theContext
           
protected  XMLTransferObject xto
           

 

Constructor Summary
CommandBox(CommandEvent theEvent, StoreService pfss, boolean identRequired)
          creates a CommandBox object that contains the common information.
CommandBox(CommandEvent theEvent, StoreService pfss, boolean identRequired, boolean getSession, boolean sessionRequired)
           
CommandBox(CommandEvent theEvent, StoreService pfss, Identifier paramIdent)
           
CommandBox(CommandEvent theEvent, StoreService pfss, Identifier paramIdent, boolean getSession, boolean sessionRequired)
           

 

Method Summary
 void clear()
           
 void clearErrors()
           
 EditorLogic getEditorLogic()
           
 java.util.Collection getErrors()
           
 Identifier getIdentifier()
           
 OutlineHandle getOutlineHandle()
           
 java.lang.String getParameter(java.lang.String key)
           
 int getParameterAsInteger(java.lang.String key)
           
 int getParameterAsInteger(java.lang.String key, int defaultValue)
           
 long getParameterAsLong(java.lang.String key)
          This method was added for SuperSize.
 long getParameterAsLong(java.lang.String key, long defaultValue)
          This method was added for SuperSize.
 java.lang.Object getParameterAsObject(java.lang.String paramKey, java.lang.Class c)
           
 ServiceContext getServiceContext()
           
 EssSession getSession()
           
 StoreService getStoreService()
           
 EssSession getTargetSession(java.lang.String serverName)
           
 XMLTransferObject getXmlObject()
           
 boolean isOkToGo()
           
 void persist()
          this is called to export data into the persistent store
 void postLogicProcessing()
          this is called after any logic command is called.
 void preLogicProcessing()
          this is called when before any logic command is called.
 void setIdentifier(Identifier identifier)
           
 void setSession(EssSession session)
           

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

identifier

protected Identifier identifier

logic

protected EditorLogic logic

theContext

protected ServiceContext theContext

xto

protected XMLTransferObject xto

oktogo

protected boolean oktogo

Constructor Detail

CommandBox

public CommandBox(CommandEvent theEvent,
                  StoreService pfss,
                  boolean identRequired)
creates a CommandBox object that contains the common information.

CommandBox

public CommandBox(CommandEvent theEvent,
                  StoreService pfss,
                  boolean identRequired,
                  boolean getSession,
                  boolean sessionRequired)

CommandBox

public CommandBox(CommandEvent theEvent,
                  StoreService pfss,
                  Identifier paramIdent)

CommandBox

public CommandBox(CommandEvent theEvent,
                  StoreService pfss,
                  Identifier paramIdent,
                  boolean getSession,
                  boolean sessionRequired)

Method Detail

getTargetSession

public EssSession getTargetSession(java.lang.String serverName)

preLogicProcessing

public void preLogicProcessing()
this is called when before any logic command is called.

postLogicProcessing

public void postLogicProcessing()
this is called after any logic command is called.

persist

public void persist()
this is called to export data into the persistent store

isOkToGo

public boolean isOkToGo()

getEditorLogic

public EditorLogic getEditorLogic()

getParameter

public java.lang.String getParameter(java.lang.String key)

getParameterAsInteger

public int getParameterAsInteger(java.lang.String key)

getParameterAsInteger

public int getParameterAsInteger(java.lang.String key,
                                 int defaultValue)

getParameterAsLong

public long getParameterAsLong(java.lang.String key)
This method was added for SuperSize. mainly used for handle.
Parameters:
key -
Returns:

getParameterAsLong

public long getParameterAsLong(java.lang.String key,
                               long defaultValue)
This method was added for SuperSize. mainly used for handle.
Parameters:
key -
defaultValue -
Returns:

getParameterAsObject

public java.lang.Object getParameterAsObject(java.lang.String paramKey,
                                             java.lang.Class c)

getStoreService

public StoreService getStoreService()

getServiceContext

public ServiceContext getServiceContext()

setSession

public void setSession(EssSession session)

getSession

public EssSession getSession()

getErrors

public java.util.Collection getErrors()

clearErrors

public void clearErrors()

getIdentifier

public Identifier getIdentifier()

setIdentifier

public void setIdentifier(Identifier identifier)

getOutlineHandle

public OutlineHandle getOutlineHandle()
                               throws HandleException
Throws:
HandleException

getXmlObject

public XMLTransferObject getXmlObject()

clear

public void clear()

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.