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
protected Stack _stack
stack of message objects

Constructor Summary
MessageStack()

Method Summary
public void clearStack()
public static Message[] clearStack(CATSession iSession)
Clears the stack, returning the current messages on the stack.
protected Object clone()
public boolean empty()
Tests if this stack is empty
public static boolean empty(CATSession iSession)
public int getSize()
public static int getSize(CATSession iSession)
public static MessageStack getStack(CATSession iSession)
public static 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).
public Message[] peekStack()
public static Message[] peekStack(CATSession iSession)
Returns the stack of messages without removing them from the stack.
public Message pop()
public static Message pop(CATSession iSession)
public void push(Message iMsg)
public static void push(Message iMsg, CATSession iSession)
Push a message onto the message stack, clearing the current msgs.
public static void push(Message iMsg, CATSession iSession, boolean iClearStack)
Push a message onto the message stack
public static void pushErrorMessage(String iMsgFile, String iMsgKey, CATSession iSession)
Push an error message
public static void pushErrorMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)
public static void pushErrorMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)
public static void pushErrorMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)
public static void pushInfoMessage(String iMsgFile, String iMsgKey, CATSession iSession)
Push an info message
public static void pushInfoMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)
public static void pushInfoMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)
public static void pushInfoMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)
public static void pushMessage(String iMsgFile, String iMsgKey, String[] iArgs, int iSeverity, CATSession iSession, boolean iClearStack)
public static void pushMessage(String iMsgFile, String iMsgKey, Vector iArgs, int iSeverity, CATSession iSession, boolean iClearStack)
public static void pushMessages(ENOVIClientCommand iCommand, CATSession iSession)
Push the message from the command onto message stack, clearing any previous messages.
public static void pushMessages(ENOVIClientCommand iCommand, CATSession iSession, boolean iClearStack)
Push the message from the command onto message stack
public static void pushMessages(ENOVICommand iCommand, CATSession iSession)
Push the message from the command onto message stack, clearing any previous messages.
public static void pushMessages(ENOVICommand iCommand, CATSession iSession, boolean iClearStack)
Push the message from the command onto message stack
public static void pushMessages(ENOVWebException iException, CATSession iSession)
Push the message from the exception onto message stack
public static void pushMessages(ENOVWebException iException, CATSession iSession, boolean iClearStack)
Push the message from the exception onto message stack
public static void pushWarningMessage(String iMsgFile, String iMsgKey, CATSession iSession)
Push an warning message
public static void pushWarningMessage(String iMsgFile, String iMsgKey, CATSession iSession, boolean iClearStack)
public static void pushWarningMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession)
public static void pushWarningMessage(String iMsgFile, String iMsgKey, String[] iMsgParms, CATSession iSession, boolean iClearStack)


Field Detail

_stack

    protected Stack _stack
stack of message objects


Constructor Detail

MessageStack

    MessageStack()


Method Detail

clearStack

    public void clearStack()


clearStack

    public static Message[] clearStack(CATSession iSession)

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


clone

    protected Object clone()


empty

    public boolean empty()

Tests if this stack is empty


empty

    public static boolean empty(CATSession iSession)


getSize

    public int getSize()


getSize

    public static int getSize(CATSession iSession)


getStack

    public static MessageStack getStack(CATSession iSession)


getStack

    public static 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

peekStack

    public Message[] peekStack()


peekStack

    public static Message[] peekStack(CATSession iSession)

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


pop

    public Message pop()


pop

    public static Message pop(CATSession iSession)


push

    public void push(Message iMsg)


push

    public static void push(Message iMsg, CATSession iSession)

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


push

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

Push a message onto the message stack


pushErrorMessage

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

Push an error message


pushErrorMessage

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


pushErrorMessage

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


pushErrorMessage

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


pushInfoMessage

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

Push an info message


pushInfoMessage

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


pushInfoMessage

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


pushInfoMessage

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


pushMessage

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


pushMessage

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


pushMessages

    public static void pushMessages(ENOVIClientCommand iCommand, CATSession iSession)

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


pushMessages

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

Push the message from the command onto message stack


pushMessages

    public static void pushMessages(ENOVICommand iCommand, CATSession iSession)

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


pushMessages

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

Push the message from the command onto message stack


pushMessages

    public static void pushMessages(ENOVWebException iException, CATSession iSession)

Push the message from the exception onto message stack


pushMessages

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

Push the message from the exception onto message stack


pushWarningMessage

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

Push an warning message


pushWarningMessage

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


pushWarningMessage

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


pushWarningMessage

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



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