1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

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

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    15 

    16 package com.symbian.smt.gui;

    17 

    18 import java.util.List;

    19 

    20 /**

    21  * PersistentSettings interface class. This is used to define the setters and

    22  * getters for the persistent plug-in and project level data stores

    23  * 

    24  * @return void

    25  */

    26 public interface PersistentSettings {

    27 

    28 	/**

    29 	 * Gets the list of advanced options from the persistent data store

    30 	 * 

    31 	 * @return String

    32 	 */

    33 	public String[] getAdvancedOptions();

    34 

    35 	/**

    36 	 * Gets the border shapes file location from the persistent data store

    37 	 * 

    38 	 * @return String

    39 	 */

    40 	String[] getBorderShapesFiles();

    41 

    42 	/**

    43 	 * Gets the border styles file location from the persistent data store

    44 	 * 

    45 	 * @return String

    46 	 */

    47 	String[] getBorderStylesFiles();

    48 

    49 	/**

    50 	 * Gets the colours file location from the persistent data store

    51 	 * 

    52 	 * @return String

    53 	 */

    54 	String[] getColoursFiles();

    55 

    56 	/**

    57 	 * Gets the copyright text from the persistent data store

    58 	 * 

    59 	 * @return String

    60 	 */

    61 	String getCopyrightText();

    62 

    63 	/**

    64 	 * Gets the System Model Managers default border shapes files location from

    65 	 * the plug-in default persistent data store

    66 	 * 

    67 	 * @return String[]

    68 	 */

    69 	public String[] getDefaultBorderShapesFiles();

    70 

    71 	/**

    72 	 * Gets the System Model Managers default border styles files location from

    73 	 * the plug-in default persistent data store

    74 	 * 

    75 	 * @return String[]

    76 	 */

    77 	public String[] getDefaultBorderStylesFiles();

    78 

    79 	/**

    80 	 * Gets the System Model Managers default colours files location from the

    81 	 * plug-in default persistent data store

    82 	 * 

    83 	 * @return String[]

    84 	 */

    85 	public String[] getDefaultColoursFiles();

    86 

    87 	/**

    88 	 * Gets the System Model Managers default dependencies files location from

    89 	 * the plug-in default persistent data store

    90 	 * 

    91 	 * @return String[]

    92 	 */

    93 	public String[] getDefaultDependenciesFiles();

    94 

    95 	/**

    96 	 * Gets the System Model Managers default distribution text from the plug-in

    97 	 * default persistent data store

    98 	 * 

    99 	 * @return String

   100 	 */

   101 	public String getDefaultDistributionText();

   102 

   103 	/**

   104 	 * Gets the System Model Managers default levels files location from the

   105 	 * plug-in default persistent data store

   106 	 * 

   107 	 * @return String[]

   108 	 */

   109 	public String[] getDefaultLevelsFiles();

   110 

   111 	/**

   112 	 * Gets the System Model Managers default localisation files location from

   113 	 * the plug-in default persistent data store

   114 	 * 

   115 	 * @return String[]

   116 	 */

   117 	public String[] getDefaultLocalisationFiles();

   118 

   119 	/**

   120 	 * Gets the System Model Managers default model version text from the

   121 	 * plug-in default persistent data store

   122 	 * 

   123 	 * @return String

   124 	 */

   125 	public String getDefaultModelVersionText();

   126 

   127 	/**

   128 	 * Gets the System Model Managers default patterns files location from the

   129 	 * plug-in default persistent data store

   130 	 * 

   131 	 * @return String[]

   132 	 */

   133 	public String[] getDefaultPatternsFiles();

   134 

   135 	/**

   136 	 * Gets the System Model Managers default printed DPI from the plug-in

   137 	 * default persistent data store

   138 	 * 

   139 	 * @return String

   140 	 */

   141 	public String getDefaultPrintedDpi();

   142 

   143 	/**

   144 	 * Gets the System Model Managers default S12 XML files location from the

   145 	 * plug-in default persistent data store

   146 	 * 

   147 	 * @return String[]

   148 	 */

   149 	public String[] getDefaultS12XmlFiles();

   150 

   151 	/**

   152 	 * Gets the System Model Managers default shapes files location from the

   153 	 * plug-in default persistent data store

   154 	 * 

   155 	 * @return String[]

   156 	 */

   157 	public String[] getDefaultShapesFiles();

   158 

   159 	/**

   160 	 * Gets the System Model Managers default system info files location from

   161 	 * the plug-in default persistent data store

   162 	 * 

   163 	 * @return String[]

   164 	 */

   165 	public String[] getDefaultSystemInfoFiles();

   166 

   167 	/**

   168 	 * Gets the dependencies file location from the persistent data store

   169 	 * 

   170 	 * @return String[]

   171 	 */

   172 	String[] getDependenciesFiles();

   173 

   174 	/**

   175 	 * Gets the distribution text values from the persistent data store

   176 	 * 

   177 	 * @return String[]

   178 	 */

   179 	String[] getDistributionTexts();

   180 

   181 	/**

   182 	 * Gets the list of filter items from the persistent data store

   183 	 * 

   184 	 * @return String

   185 	 */

   186 	String[] getFilterItems();

   187 

   188 	/**

   189 	 * Gets the fix item size option from the persistent data store

   190 	 * 

   191 	 * @return a Boolean value indicating whether or not the fix item size

   192 	 *         option is checked

   193 	 */

   194 	public Boolean getFixItemSize();

   195 

   196 	/**

   197 	 * Gets the highlight core OS option from the persistent data store

   198 	 * 

   199 	 * @return String

   200 	 */

   201 	Boolean getHighlightCoreOS();

   202 

   203 	/**

   204 	 * Gets the list of ignore items from the persistent data store

   205 	 * 

   206 	 * @return String

   207 	 */

   208 	List<String[]> getIgnoreItems();

   209 

   210 	/**

   211 	 * Gets the level of detail from the persistent data store

   212 	 * 

   213 	 * @return String

   214 	 */

   215 	String getLevelOfDetail();

   216 

   217 	/**

   218 	 * Gets the levels file location from the persistent data store

   219 	 * 

   220 	 * @return String

   221 	 */

   222 	String[] getLevelsFiles();

   223 

   224 	/**

   225 	 * Gets the localisation file location from the persistent data store

   226 	 * 

   227 	 * @return String

   228 	 */

   229 	String[] getLocalisationFiles();

   230 

   231 	/**

   232 	 * Gets the model name from the persistent data store

   233 	 * 

   234 	 * @return String

   235 	 */

   236 	String getModelName();

   237 

   238 	/**

   239 	 * Gets the model version from the persistent data store

   240 	 * 

   241 	 * @return String

   242 	 */

   243 	String getModelVersion();

   244 

   245 	/**

   246 	 * Gets the model version text values from the persistent data store

   247 	 * 

   248 	 * @return String[]

   249 	 */

   250 	String[] getModelVersionTexts();

   251 

   252 	/**

   253 	 * Gets the patterns file locations from the persistent data store

   254 	 * 

   255 	 * @return String[]

   256 	 */

   257 	String[] getPatternsFiles();

   258 

   259 	/**

   260 	 * Gets the printed DPI values from the persistent data store

   261 	 * 

   262 	 * @return String[]

   263 	 */

   264 	public String[] getPrintedDpis();

   265 

   266 	public String[] getS12XmlFiles();

   267 

   268 	/**

   269 	 * Gets the user selected border shapes file location from the persistent

   270 	 * data store

   271 	 * 

   272 	 * @return String

   273 	 */

   274 	String[] getSelectedBorderShapesFiles();

   275 

   276 	/**

   277 	 * Gets the user selected border styles file location from the persistent

   278 	 * data store

   279 	 * 

   280 	 * @return String

   281 	 */

   282 	String[] getSelectedBorderStylesFiles();

   283 

   284 	/**

   285 	 * Gets the user selected colours file location from the persistent data

   286 	 * store

   287 	 * 

   288 	 * @return String

   289 	 */

   290 	String[] getSelectedColoursFiles();

   291 

   292 	/**

   293 	 * Gets the user selected dependencies file location from the persistent

   294 	 * data store

   295 	 * 

   296 	 * @return String

   297 	 */

   298 	String[] getSelectedDependenciesFiles();

   299 

   300 	/**

   301 	 * Gets the selected distribution text value from the persistent data store

   302 	 * 

   303 	 * @return String

   304 	 */

   305 	public String getSelectedDistributionText();

   306 

   307 	/**

   308 	 * Gets the user selected levels file location from the persistent data

   309 	 * store

   310 	 * 

   311 	 * @return String

   312 	 */

   313 	String[] getSelectedLevelsFiles();

   314 

   315 	/**

   316 	 * Gets the user selected localisation file location from the persistent

   317 	 * data store

   318 	 * 

   319 	 * @return String

   320 	 */

   321 	String[] getSelectedLocalisationFiles();

   322 

   323 	/**

   324 	 * Gets the selected model version text value from the persistent data store

   325 	 * 

   326 	 * @return String

   327 	 */

   328 	public String getSelectedModelVersionText();

   329 

   330 	/**

   331 	 * Gets the user selected patterns file location from the persistent data

   332 	 * store

   333 	 * 

   334 	 * @return String

   335 	 */

   336 	String[] getSelectedPatternsFiles();

   337 

   338 	/**

   339 	 * Gets the selected printed DPI value from the persistent data store

   340 	 * 

   341 	 * @return String

   342 	 */

   343 	public String getSelectedPrintedDpi();

   344 

   345 	public String[] getSelectedS12XmlFiles();

   346 

   347 	/**

   348 	 * Gets the user selected shapes file location from the persistent data

   349 	 * store

   350 	 * 

   351 	 * @return String

   352 	 */

   353 	String[] getSelectedShapesFiles();

   354 

   355 	/**

   356 	 * Gets the user selected system info file location from the persistent data

   357 	 * store

   358 	 * 

   359 	 * @return String

   360 	 */

   361 	String[] getSelectedSystemInfoFiles();

   362 

   363 	/**

   364 	 * Gets the shapes file location from the persistent data store

   365 	 * 

   366 	 * @return String

   367 	 */

   368 	String[] getShapesFiles();

   369 

   370 	/**

   371 	 * Gets a boolean value indicating if the Suppress Mouseover Effect button

   372 	 * has been selected from the persistent data store

   373 	 * 

   374 	 * @return Boolean

   375 	 */

   376 	Boolean getSuppressMouseOverEffect();

   377 

   378 	/**

   379 	 * Gets the list of system definition files from the persistent data store

   380 	 * 

   381 	 * @return String[]

   382 	 */

   383 	String[] getSystemDefinitionFiles();

   384 

   385 	/**

   386 	 * Gets the system info file location from the persistent data store

   387 	 * 

   388 	 * @return String

   389 	 */

   390 	String[] getSystemInfoFiles();

   391 

   392 	/**

   393 	 * Gets the system name from the persistent data store

   394 	 * 

   395 	 * @return String

   396 	 */

   397 	String getSystemName();

   398 

   399 	/**

   400 	 * Gets the system version from the persistent data store

   401 	 * 

   402 	 * @return String

   403 	 */

   404 	String getSystemVersion();

   405 

   406 	/**

   407 	 * Gets the warning level to use from the persistent data store

   408 	 * 

   409 	 * @return String

   410 	 */

   411 	String getWarningLevel();

   412 

   413 	/**

   414 	 * Writes the list of advanced options to the persistent data store

   415 	 * 

   416 	 * @param advancedOptionsList

   417 	 *            List of advanced options

   418 	 * @return void

   419 	 */

   420 	public void setAdvancedOptions(String[] options);

   421 

   422 	/**

   423 	 * Writes the border shapes file location to the persistent data store

   424 	 * 

   425 	 * @param borderShapesFile

   426 	 *            Location of the border shapes file

   427 	 * @return void

   428 	 */

   429 	void setBorderShapesFiles(String[] borderShapesFiles);

   430 

   431 	/**

   432 	 * Writes the border styles file location to the persistent data store

   433 	 * 

   434 	 * @param borderStylesFile

   435 	 *            Location of the border styles file

   436 	 * @return void

   437 	 */

   438 	void setBorderStylesFiles(String[] borderStylesFiles);

   439 

   440 	/**

   441 	 * Writes the colours file location to the persistent data store

   442 	 * 

   443 	 * @param coloursFile

   444 	 *            Location of the colours file

   445 	 * @return void

   446 	 */

   447 	void setColoursFiles(String[] coloursFiles);

   448 

   449 	/**

   450 	 * Writes the copyright text to the persistent data store

   451 	 * 

   452 	 * @param copyrightText

   453 	 *            String to be used for the copyright text

   454 	 * @return void

   455 	 */

   456 	void setCopyrightText(String copyrightText);

   457 

   458 	/**

   459 	 * Writes the dependencies file location to the persistent data store

   460 	 * 

   461 	 * @param dependenciesFile

   462 	 *            Location of the dependencies file

   463 	 * @return void

   464 	 */

   465 	void setDependenciesFiles(String[] dependenciesFiles);

   466 

   467 	/**

   468 	 * Writes the distribution text values to the persistent data store

   469 	 * 

   470 	 * @param distributionTexts

   471 	 *            String array to be used for the distribution text values

   472 	 * @return void

   473 	 */

   474 	void setDistributionTexts(String[] distributionTexts);

   475 

   476 	/**

   477 	 * Writes the list of filter items to the persistent data store

   478 	 * 

   479 	 * @param filterItemsList

   480 	 *            List of filter names

   481 	 * @return void

   482 	 */

   483 	void setFilterItems(String[] filterItemsList);

   484 

   485 	/**

   486 	 * Writes the fix item size option to the persistent data store

   487 	 * 

   488 	 * @param fixItemSize

   489 	 *            Boolean to represent the fix item size option

   490 	 * @return void

   491 	 */

   492 	public void setFixItemSize(Boolean fixItemSize);

   493 

   494 	/**

   495 	 * Writes the highlight core OS option to the persistent data store

   496 	 * 

   497 	 * @param highlightCoreOS

   498 	 *            Boolean to represent the highlight core OS option

   499 	 * @return void

   500 	 */

   501 	void setHighlightCoreOS(Boolean highlightCoreOS);

   502 

   503 	/**

   504 	 * Writes the list of ignore items to the persistent data store

   505 	 * 

   506 	 * @param ignoreItemsList

   507 	 *            List of ignore items

   508 	 * @return void

   509 	 */

   510 	void setIgnoreItems(List<String[]> ignoreItemsList);

   511 

   512 	/**

   513 	 * Writes the level of detail to the persistent data store

   514 	 * 

   515 	 * @param levelOfDetail

   516 	 *            String to be used for the level of detail

   517 	 * @return void

   518 	 */

   519 	void setLevelOfDetail(String levelOfDetail);

   520 

   521 	/**

   522 	 * Writes the levels file location to the persistent data store

   523 	 * 

   524 	 * @param levelsFile

   525 	 *            Location of the levels file

   526 	 * @return void

   527 	 */

   528 	void setLevelsFiles(String[] levelsFiles);

   529 

   530 	/**

   531 	 * Writes the localisation file location to the persistent data store

   532 	 * 

   533 	 * @param localisationFile

   534 	 *            Location of the localisation file

   535 	 * @return void

   536 	 */

   537 	void setLocalisationFiles(String[] localisationFiles);

   538 

   539 	/**

   540 	 * Writes the model name to the persistent data store

   541 	 * 

   542 	 * @param modelName

   543 	 *            String to be used for the model name

   544 	 * @return void

   545 	 */

   546 	void setModelName(String modelName);

   547 

   548 	/**

   549 	 * Writes the model version to the persistent data store

   550 	 * 

   551 	 * @param modelVersion

   552 	 *            String to be used for the model version

   553 	 * @return void

   554 	 */

   555 	void setModelVersion(String modelVersion);

   556 

   557 	/**

   558 	 * Writes the model version text values to the persistent data store

   559 	 * 

   560 	 * @param modelVersionTexts

   561 	 *            String array to be used for the model version text values

   562 	 * @return void

   563 	 */

   564 	void setModelVersionTexts(String[] modelVersionTexts);

   565 

   566 	/**

   567 	 * Writes the patterns file location to the persistent data store

   568 	 * 

   569 	 * @param patternsFile

   570 	 *            Location of the patterns file

   571 	 * @return void

   572 	 */

   573 	void setPatternsFiles(String[] patternsFiles);

   574 

   575 	/**

   576 	 * Writes the printed DPI values to the persistent data store

   577 	 * 

   578 	 * @param dpi

   579 	 *            String array to be used for the printed DPI values

   580 	 * @return void

   581 	 */

   582 	public void setPrintedDpis(String[] dpis);

   583 

   584 	public void setS12XmlFiles(String[] s12XmlFiles);

   585 

   586 	/**

   587 	 * Writes the user selected border shapes file location to the persistent

   588 	 * data store

   589 	 * 

   590 	 * @param borderShapesFile

   591 	 *            Location of the default border shapes file

   592 	 * @return void

   593 	 */

   594 	void setSelectedBorderShapesFiles(String[] borderShapesFiles);

   595 

   596 	/**

   597 	 * Writes the user selected border styles file location to the persistent

   598 	 * data store

   599 	 * 

   600 	 * @param borderStylesFile

   601 	 *            Location of the default border styles file

   602 	 * @return void

   603 	 */

   604 	void setSelectedBorderStylesFiles(String[] borderStylesFile);

   605 

   606 	/**

   607 	 * Writes the user selected colours file location to the persistent data

   608 	 * store

   609 	 * 

   610 	 * @param coloursFile

   611 	 *            Location of the default colours file

   612 	 * @return void

   613 	 */

   614 	void setSelectedColoursFiles(String[] coloursFile);

   615 

   616 	/**

   617 	 * Writes the user selected dependencies file location to the persistent

   618 	 * data store

   619 	 * 

   620 	 * @param dependenciesFile

   621 	 *            Location of the default dependencies file

   622 	 * @return void

   623 	 */

   624 	void setSelectedDependenciesFiles(String[] dependenciesFile);

   625 

   626 	/**

   627 	 * Writes the selected distribution text value to the persistent data store

   628 	 * 

   629 	 * @param distributionText

   630 	 *            String to be used for the selected distribution text value

   631 	 * @return void

   632 	 */

   633 	public void setSelectedDistributionText(String distributionText);

   634 

   635 	/**

   636 	 * Writes the user selected levels file location to the persistent data

   637 	 * store

   638 	 * 

   639 	 * @param levelsFile

   640 	 *            Location of the default levels file

   641 	 * @return void

   642 	 */

   643 	void setSelectedLevelsFiles(String[] levelsFile);

   644 

   645 	/**

   646 	 * Writes the user selected localisation file location to the persistent

   647 	 * data store

   648 	 * 

   649 	 * @param localisationFile

   650 	 *            Location of the default localisation file

   651 	 * @return void

   652 	 */

   653 	void setSelectedLocalisationFiles(String[] localisationFile);

   654 

   655 	/**

   656 	 * Writes the selected model version text value to the persistent data store

   657 	 * 

   658 	 * @param modelVersionText

   659 	 *            String to be used for the selected model version text value

   660 	 * @return void

   661 	 */

   662 	public void setSelectedModelVersionText(String modelVersionText);

   663 

   664 	/**

   665 	 * Writes the user selected patterns file location to the persistent data

   666 	 * store

   667 	 * 

   668 	 * @param patternsFile

   669 	 *            Location of the default patterns file

   670 	 * @return void

   671 	 */

   672 	void setSelectedPatternsFiles(String[] patternsFiles);

   673 

   674 	/**

   675 	 * Writes the selected printed DPI value to the persistent data store

   676 	 * 

   677 	 * @param dpi

   678 	 *            String to be used for the selected printed DPI value

   679 	 * @return void

   680 	 */

   681 	public void setSelectedPrintedDpi(String dpi);

   682 

   683 	public void setSelectedS12XmlFiles(String[] s12XmlFiles);

   684 

   685 	/**

   686 	 * Writes the user selected shapes file location to the persistent data

   687 	 * store

   688 	 * 

   689 	 * @param shapesFile

   690 	 *            Location of the default shapes file

   691 	 * @return void

   692 	 */

   693 	void setSelectedShapesFiles(String[] shapesFile);

   694 

   695 	/**

   696 	 * Writes the user selected system info location to the persistent data

   697 	 * store

   698 	 * 

   699 	 * @param systemInfoFile

   700 	 *            Location of the default system information file

   701 	 * @return void

   702 	 */

   703 	void setSelectedSystemInfoFiles(String[] systemInfoFile);

   704 

   705 	/**

   706 	 * Writes the shapes file location to the persistent data store

   707 	 * 

   708 	 * @param shapesFile

   709 	 *            Location of the shapes file

   710 	 * @return void

   711 	 */

   712 	void setShapesFiles(String[] shapesFiles);

   713 

   714 	/**

   715 	 * Writes the value for the Suppress Mouseover Effect option

   716 	 * 

   717 	 * @param suppressMouseOverEffect

   718 	 *            Boolean value indicating if the Suppress Mouseover Effect is

   719 	 *            it be used when generating the diagram

   720 	 * @return void

   721 	 */

   722 	public void setSuppressMouseOverEffect(Boolean suppressMouseOverEffect);

   723 

   724 	/**

   725 	 * Writes the list of system definition files to the persistent data store

   726 	 * 

   727 	 * @param sysDefFiles

   728 	 *            List of the system definition file locations

   729 	 * @return void

   730 	 */

   731 	void setSystemDefinitionFiles(String[] sysDefFiles);

   732 

   733 	/**

   734 	 * Writes the system info location to the persistent data store

   735 	 * 

   736 	 * @param systemInfoFile

   737 	 *            Location of the system information file

   738 	 * @return void

   739 	 */

   740 	void setSystemInfoFiles(String[] systemInfoFiles);

   741 

   742 	/**

   743 	 * Writes the system name to the persistent data store

   744 	 * 

   745 	 * @param systemName

   746 	 *            String to be used for the system name

   747 	 * @return void

   748 	 */

   749 	void setSystemName(String systemName);

   750 

   751 	/**

   752 	 * Writes the system version to the persistent data store

   753 	 * 

   754 	 * @param systemVersion

   755 	 *            String to be used for the system version

   756 	 * @return void

   757 	 */

   758 	void setSystemVersion(String systemVersion);

   759 

   760 	/**

   761 	 * Writes the warning level to the persistent data store

   762 	 * 

   763 	 * @param warningLevel

   764 	 *            An int between 1 and 3 indicating the level of warnings to be

   765 	 *            produces

   766 	 * @return void

   767 	 */

   768 	void setWarningLevel(String warningLevel);

   769 }