Package com.dassault_systemes.pprnblcabase.utils

   
Class MessageStack

 
Class Hierarchy
java.lang.Object
  |
  +-com.dassault_systemes.pprnblcabase.utils.MessageStack
Class Location

Framework : PPRJNavigatorBase

Module : PPRNBLcaBase

Class Description

public class MessageStack

Class to manage a stack of messages. An instance of this class will exists in the CATSession.

   All Implemented Interfaces:
Cloneable
Field Summary
Stack _stack

Constructor Summary
MessageStack()

Method Summary
void pushMessages(ENOVIClientCommand iCommand, CATSession iSession)
void pushMessages(ENOVIClientCommand iCommand, CATSession iSession, boolean iClearStack)
void pushMessages(ENOVICommand iCommand, CATSession iSession)
void pushMessages(ENOVICommand iCommand, CATSession iSession, boolean iClearStack)
void pushMessages(ENOVWebException iException, CATSession iSession)
void pushMessages(ENOVWebException iException, CATSession iSession, boolean iClearStack)
void pushErrorMessage(String iMsgFile, String iMsgKey, CATSession iSession)
void pushErrorMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)
void pushErrorMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)
void pushErrorMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)
void pushWarningMessage(String iMsgFile, String iMsgKey, CATSession iSession)
void pushWarningMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)
void pushWarningMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)
void pushWarningMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)
void pushInfoMessage(String iMsgFile, String iMsgKey, CATSession iSession)
void pushInfoMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)
void pushInfoMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)
void pushInfoMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)
void pushMessage(String iMsgFile, String iMsgKey, String[] iArgs, int iSeverity, CATSession iSession, boolean iClearStack)
void pushMessage(String iMsgFile, String iMsgKey, Vector iArgs, int iSeverity, CATSession iSession, boolean iClearStack)
void push(Message iMsg, CATSession iSession)
void push(Message iMsg, CATSession iSession, boolean iClearStack)
Message pop(CATSession iSession)
boolean empty(CATSession iSession)
int getSize(CATSession iSession)
Message[] clearStack(CATSession iSession)
Message[] peekStack(CATSession iSession)
MessageStack getStack(CATSession iSession)
MessageStack getStack(CATSession iSession, boolean iCloneAndClear)
Object clone()
void push(Message iMsg)
Message pop()
boolean empty()
void clearStack()
Message[] peekStack()
int getSize()


Field Detail

_stack

    Stack _stack
stack of message objects


Constructor Detail

MessageStack

    MessageStack()


Method Detail

pushMessages

    void pushMessages(ENOVIClientCommand iCommand, CATSession iSession)

Push the message from the command onto message stack, clearing any previous messages.


pushMessages

    void pushMessages(ENOVIClientCommand iCommand, CATSession iSession, boolean iClearStack)

Push the message from the command onto message stack


pushMessages

    void pushMessages(ENOVICommand iCommand, CATSession iSession)

Push the message from the command onto message stack, clearing any previous messages.


pushMessages

    void pushMessages(ENOVICommand iCommand, CATSession iSession, boolean iClearStack)

Push the message from the command onto message stack


pushMessages

    void pushMessages(ENOVWebException iException, CATSession iSession)

Push the message from the exception onto message stack


pushMessages

    void pushMessages(ENOVWebException iException, CATSession iSession, boolean iClearStack)

Push the message from the exception onto message stack


pushErrorMessage

    void pushErrorMessage(String iMsgFile, String iMsgKey, CATSession iSession)

Push an error message


pushErrorMessage

    void pushErrorMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)


pushErrorMessage

    void pushErrorMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)


pushErrorMessage

    void pushErrorMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)


pushWarningMessage

    void pushWarningMessage(String iMsgFile, String iMsgKey, CATSession iSession)

Push an warning message


pushWarningMessage

    void pushWarningMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)


pushWarningMessage

    void pushWarningMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)


pushWarningMessage

    void pushWarningMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)


pushInfoMessage

    void pushInfoMessage(String iMsgFile, String iMsgKey, CATSession iSession)

Push an info message


pushInfoMessage

    void pushInfoMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)


pushInfoMessage

    void pushInfoMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)


pushInfoMessage

    void pushInfoMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)


pushMessage

    void pushMessage(String iMsgFile, String iMsgKey, String[] iArgs, int iSeverity, CATSession iSession, boolean iClearStack)


pushMessage

    void pushMessage(String iMsgFile, String iMsgKey, Vector iArgs, int iSeverity, CATSession iSession, boolean iClearStack)


push

    void push(Message iMsg, CATSession iSession)

Push a message onto the message stack, clearing the current msgs.


push

    void push(Message iMsg, CATSession iSession, boolean iClearStack)

Push a message onto the message stack


pop

    Message pop(CATSession iSession)


empty

    boolean empty(CATSession iSession)


getSize

    int getSize(CATSession iSession)


clearStack

    Message[] clearStack(CATSession iSession)

Clears the stack, returning the current messages on the stack.


peekStack

    Message[] peekStack(CATSession iSession)

Returns the stack of messages without removing them from the stack.


getStack

    MessageStack getStack(CATSession iSession)


getStack

    MessageStack getStack(CATSession iSession, boolean iCloneAndClear)

If iCloneAndClear is true, a copy of the session stack will be returned and the the session stack will be cleared (emptied).

Parameters:
iSession
user session
iCloneAndClear

clone

    Object clone()


push

    void push(Message iMsg)


pop

    Message pop()


empty

    boolean empty()

Tests if this stack is empty


clearStack

    void clearStack()


peekStack

    Message[] peekStack()


getSize

    int getSize()



Copyright © 2000, Dassault Systèmes. All rights reserved