core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/ISymbianSDKModifier.java
author stechong
Fri, 11 Jun 2010 12:09:52 -0500
branchC3_BUILDER_WORK
changeset 1462 b38491fd06da
parent 1434 79471fd1fd69
child 1667 352fb86872dd
permissions -rw-r--r--
More ISymbianSDK refactoring.

/*
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). 
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of the License "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
*/

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

import org.eclipse.core.runtime.IPath;
import org.osgi.framework.Version;

import com.nokia.carbide.cpp.sdk.core.ISDKBuildInfo;

/**
 * Interface for modifying various attributes of Symbian OS SDK.
 *
 */
public interface ISymbianSDKModifier {

	/**
	 * Add a feature supported by the SDK.
	 * @param feature supported feature
	 */
	void addSupportedFeature(Object feature);

	/**
	 * Sets the build info for a particular builder.
	 * @param buildInfo build info
	 * @param builderId id string of a builder
	 */
	void setBuildInfo(ISDKBuildInfo buildInfo, String builderId);

	/**
	 * Marks the SDK as enabled or disabled.
	 * @param enable whether to enable or disable the SDK
	 */
	void setEnabled(boolean enable);

	/**
	 * Set the absolute path to the epoc32 directory of this SDK.
	 * @param epocRoot absolute path to the epoc32 directory
	 */
	void setEPOCROOT(String epocRoot);

	/**
	 * Sets display name of a SDK. This is the com.vendor.family identifier.
	 * @param name SDK display name
	 */
	void setName(String name);

	/**
	 * Sets the OS version string of a SDK.
	 * @param osVer OS version
	 */
	public void setOSVersion(Version osVer);

	/**
	 * Sets the prefix file for a particular builder.
	 * @param prefixFile path of prefix file
	 * @param builderId id string of a builder
	 */
	void setPrefixFile(IPath prefixFile, String builderId);

	/**
	 * Sets the SDK version string of a SDK.
	 * @param sdkVers SDK version
	 */
	void setSDKVersion(Version sdkVers);

	/**
	 * Sets the unique id of a SDK.
	 * @param id id string of a SDK
	 */
	void setUniqueId(String id);

}