1 /*

     2 * Copyright (c) 2010 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 the License "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 * Test the BldInfViewPathHelper class.

    16 *

    17 */

    18 package com.nokia.carbide.cpp.internal.api.sdk.sbsv2;

    19 

    20 import com.nokia.carbide.cpp.sdk.core.ISymbianSDK;

    21 

    22 /** 

    23  * Data that describes the meaning of a single build configuration, as discovered by SBS

    24  *  

    25  *  @noimplement

    26  */

    27 public interface ISBSv2ConfigData {

    28 

    29 	/**

    30 	 * Get the usable SBS build alias that can be used for the -c parameter

    31 	 * @return the unique build alias

    32 	 */

    33 	String getBuildAlias();

    34 	

    35 	/**

    36 	 * Get the meaning (aka dotted name, component name) fo the build alias. 

    37 	 * Can also be used as a -c argument in SBS

    38 	 * @return the meaning

    39 	 */

    40 	String getMeaning();

    41 	

    42 	/**

    43 	 * Get the directory for a given SDK where binaries are output

    44 	 * @param sdk - use null if for base configuration

    45 	 * @return the portable OS string starting from /epoc32/

    46 	 */

    47 	String getReleaseDirectory(ISymbianSDK sdk);

    48 	

    49 	/** 

    50 	 * TODO: This API is not yet defined.

    51 	 * @param sdk

    52 	 * @return

    53 	 */

    54 	ISBSv2ConfigPreprocessorInfo getBuildData(ISymbianSDK sdk);

    55 	

    56 	/**

    57 	 * Get the name of the folder where executable binaries are written (typically 'debug' or 'release')

    58 	 * @param sdk - use null for base configuration

    59 	 * @return string of folder name

    60 	 */

    61 	String getTraditionalTarget(ISymbianSDK sdk);

    62 	

    63 	/**

    64 	 * Get the name of the folder where executable binaries are written (component before the target)

    65 	 * @param sdk - use null for base configuration

    66 	 * @return string of folder name

    67 	 */

    68 	String getTraditionalPlatform(ISymbianSDK sdk);

    69 	

    70 	/**

    71 	 * Get the SDK for which this configuration was qeuried.

    72 	 * @return the SDK, or null if it's a base sbs configuration

    73 	 */

    74 	ISymbianSDK getSupportingSDK();

    75 	

    76 }