IIDStoreAdapter.java

/****************************************************************************
 * Copyright (c) 2008 Composent, Inc. and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Composent, Inc. - initial API and implementation
 *****************************************************************************/

package org.eclipse.ecf.storage;

import org.eclipse.ecf.core.identity.IDCreateException;

/**
 * Adapter for retrieving ID name for storage.
 */
public interface IIDStoreAdapter {

	/**
	 * Get the ID name for storage.
	 * @return String name for storage.  Must not return <code>null</code>.
	 */
	public String getNameForStorage();

	/**
	 * Set the name of the ID instace from storage.
	 * @param valueFromStorage the value from {@link #getNameForStorage()}.
	 * @throws IDCreateException throws in valueFromStorage cannot be used to initialize
	 */
	public void initializeFromStorage(String valueFromStorage) throws IDCreateException;

}