001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.uml.core.support.umlmessagingcore;
043:
044: import org.netbeans.modules.uml.core.support.umlutils.ETList;
045:
046: public interface IMessageData {
047: /**
048: * Get/Set the text of the message
049: */
050: public String getMessageString();
051:
052: /**
053: * Get/Set the text of the message
054: */
055: public void setMessageString(String value);
056:
057: /**
058: * Get/Set the message type.
059: */
060: public int getMessageType();
061:
062: /**
063: * Get/Set the message type.
064: */
065: public void setMessageType( /* MESSAGE_TYPE */int value);
066:
067: /**
068: * Clone this message data object to create a new one.
069: */
070: public IMessageData clone();
071:
072: /**
073: * Get/Set the name of the facility that is generating this message data object.
074: */
075: public String getFacility();
076:
077: /**
078: * Get/Set the name of the facility that is generating this message data object.
079: */
080: public void setFacility(String value);
081:
082: /**
083: * Get a formatted message string that is suitable for display.
084: */
085: public String getFormattedMessageString(boolean bAddTimestamp);
086:
087: /**
088: * Get the timestamp that this message data's messagestring was set in a character format
089: */
090: public String getTimestamp();
091:
092: /**
093: * Get the message type of this object in a character format rather then an enumeration
094: */
095: public String getMessageTypeString();
096:
097: /**
098: * Get/Set the sub messages
099: */
100: public ETList<IMessageData> getSubMessages();
101:
102: /**
103: * Get/Set the sub messages
104: */
105: public void setSubMessages(ETList<IMessageData> value);
106:
107: /**
108: * Get/Set the raw time which is in time_t format.
109: */
110: public long getTimeT();
111:
112: /**
113: * Get/Set the raw time which is in time_t format.
114: */
115: public void setTimeT(long value);
116:
117: /**
118: * Sets various details of the message
119: */
120: public void setDetails( /* MESSAGE_TYPE */int nMessageType,
121: String sFacility, String value);
122:
123: /**
124: * Adds this message to the list of sub messages
125: */
126: public void addSubMessage(IMessageData pSubMessage);
127:
128: /**
129: * Adds this message to the list of sub messages
130: */
131: public IMessageData addSubMessage(
132: /* MESSAGE_TYPE */int nMessageType, String sFacility,
133: String sMessageString);
134:
135: /**
136: * Adds this message to the list of sub messages. The facility string is loaded from hInstance with the id being nFacilityStringID.
137: */
138: public IMessageData addSubMessage(
139: /* MESSAGE_TYPE */int nMessageType, int hInstance,
140: int nFacilityStringID, String sMessageString);
141:
142: }
|