1 /*

     2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). 

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 *

    16 * Content verifier interface for trace objects

    17 *

    18 */

    19 package com.nokia.tracecompiler.model;

    20 

    21 /**

    22  * Content verifier interface for trace objects

    23  * 

    24  */

    25 public interface TraceObjectPropertyVerifier {

    26 

    27 	/**

    28 	 * Checks the properties of a trace before it is created or modified

    29 	 * 

    30 	 * @param group

    31 	 *            the group for the trace

    32 	 * @param trace

    33 	 *            trace to be modified. If creating new, this is null

    34 	 * @param id

    35 	 *            the trace ID

    36 	 * @param name

    37 	 *            the name of the trace

    38 	 * @param data

    39 	 *            the trace data

    40 	 * @throws TraceCompilerException

    41 	 *             if properties are not valid. The error code from the

    42 	 *             exception is used to create an error dialog

    43 	 */

    44 	public void checkTraceProperties(TraceGroup group, Trace trace, int id,

    45 			String name, String data) throws TraceCompilerException;

    46 

    47 	/**

    48 	 * Checks the properties of a trace group before it is created or modified

    49 	 * 

    50 	 * @param owner

    51 	 *            the model owning the trace group

    52 	 * @param group

    53 	 *            group to be modified. If creating new, this is null

    54 	 * @param id

    55 	 *            the trace ID

    56 	 * @param name

    57 	 *            the name of the trace

    58 	 * @throws TraceCompilerException

    59 	 *             if properties are not valid. The error code from the

    60 	 *             exception is used to create an error dialog

    61 	 */

    62 	public void checkTraceGroupProperties(TraceModel owner, TraceGroup group,

    63 			int id, String name) throws TraceCompilerException;

    64 

    65 	/**

    66 	 * Checks the properties of a parameter before it is created or modified

    67 	 * 

    68 	 * @param owner

    69 	 *            the parameter owner

    70 	 * @param parameter

    71 	 *            parameter to be modified. If creating new, this is null

    72 	 * @param id

    73 	 *            the parameter ID

    74 	 * @param name

    75 	 *            the name of the parameter

    76 	 * @param type

    77 	 *            the type of the parameter

    78 	 * @throws TraceCompilerException

    79 	 *             if properties are not valid. The error code from the

    80 	 *             exception is used to create an error dialog

    81 	 */

    82 	public void checkTraceParameterProperties(Trace owner,

    83 			TraceParameter parameter, int id, String name, String type)

    84 			throws TraceCompilerException;

    85 

    86 	/**

    87 	 * Checks the properties of a constant table before it is created or

    88 	 * modified

    89 	 * 

    90 	 * @param owner

    91 	 *            the model owning the constant table

    92 	 * @param table

    93 	 *            the table to be changed. If creating new, this is null

    94 	 * @param id

    95 	 *            the ID of the table

    96 	 * @param tableName

    97 	 *            the name of the table

    98 	 * @throws TraceCompilerException

    99 	 *             if properties are not valid. The error code from the

   100 	 *             exception is used to create an error dialog

   101 	 */

   102 	public void checkConstantTableProperties(TraceModel owner,

   103 			TraceConstantTable table, int id, String tableName)

   104 			throws TraceCompilerException;

   105 

   106 	/**

   107 	 * Checks the properties of a constant table entry before it is created

   108 	 * 

   109 	 * @param table

   110 	 *            the constant table

   111 	 * @param entry

   112 	 *            the entry to be modified. If creating new, this is null

   113 	 * @param id

   114 	 *            the ID for the new entry

   115 	 * @param value

   116 	 *            the value for the new entry

   117 	 * @throws TraceCompilerException

   118 	 *             if properties are not valid. The error code from the

   119 	 *             exception is used to create an error dialog

   120 	 */

   121 	public void checkConstantProperties(TraceConstantTable table,

   122 			TraceConstantTableEntry entry, int id, String value)

   123 			throws TraceCompilerException;

   124 

   125 	/**

   126 	 * Checks the properties of trace model before it is modified

   127 	 * 

   128 	 * @param model

   129 	 *            the trace model

   130 	 * @param id

   131 	 *            the model ID

   132 	 * @param name

   133 	 *            the model name

   134 	 * @param path

   135 	 *            the model path

   136 	 * @throws TraceCompilerException

   137 	 *             if properties are not valid. The error code from the

   138 	 *             exception is used to create an error dialog

   139 	 */

   140 	public void checkTraceModelProperties(TraceModel model, int id,

   141 			String name, String path) throws TraceCompilerException;

   142 

   143 }