nl.toolforge.karma.core.boot
Interface Store

All Known Implementing Classes:

AdminStore

public interface Store

Version:

$Id: Store.java,v 1.4 2004/11/10 23:53:07 asmedes Exp $

Author:

D.A. Smedes

Method Summary

ErrorCode	checkConfiguration() Checks if the configuration of the store is ok.
Module	getModule()
java.lang.String	getModuleName()
void	setLocation(Location location) Assigns this Store a Location.
void	setModuleName(java.lang.String moduleName) Sets the module name for this ManifestStore.
void	update() Updates the local checkout of the manifest store.

Method Detail

update

public void update()
            throws AuthenticationException,
                   VersionControlException,
                   WorkingContextException

Updates the local checkout of the manifest store.

Throws:

AuthenticationException - When the location for this Store cannot be authenticated.

VersionControlException - When the update failed.

WorkingContextException

setLocation

public void setLocation(Location location)

Assigns this Store a Location. The Location contains a module with administrative files for Karma to run.

Parameters:

location - The location for this store.

setModuleName

public void setModuleName(java.lang.String moduleName)

Sets the module name for this ManifestStore. This name is assumed to be the name of the module in a version control repository. The moduleName should be including any offset-directory in the version control system.

Parameters:

moduleName - The module name for the manifest store.

getModule

public Module getModule()

getModuleName

public java.lang.String getModuleName()

checkConfiguration

public ErrorCode checkConfiguration()

Checks if the configuration of the store is ok.

Returns:

An ErrorCode instance with the first encountered error, or null if none happened.