de.espirit.firstspirit.opt.office

Interface OfficeImportService

public interface OfficeImportService

$Date$

Version:

$Revision$

Field Summary

Fields

Modifier and Type	Field and Description
static String	RULESET_ENCODING

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCache()
Map<String,String>	getAvailableRulesets(long projectId)
Map<String,String>	getAvailableRulesetsFromCache(long projectId)
String	getName() Get the module name, same as in module.xml
String	getProjectConfigFileName()
ProjectProperties	getProjectProperties(long projectID)
String	getRulesetConfigFileName()
TransformationRules	getRuleSetConfiguration() Get the global ruleset configuration
TransformationRules	getRuleSetConfiguration(long projectID) Get the project ruleset configuration
TransformationRules	getTransformationRules(String rulesetName, long projectId) Get the transformation rules for rule set name.
boolean	isStarted() Method to get service state in gui methods.
void	setProjectProperties(long projectID, ProjectProperties properties)
void	setRuleSetConfiguration(TransformationRules ruleSet) Set the RuleSetConfiguration XML representation.
void	setRuleSetConfiguration(TransformationRules ruleSet, long projectID) Set the RuleSetConfiguration XML representation.

Field Detail

RULESET_ENCODING

static final String RULESET_ENCODING

See Also:

Constant Field Values

Method Detail

getRuleSetConfiguration

TransformationRules getRuleSetConfiguration()

Get the global ruleset configuration

Returns:

RuleSetConfiguration

getRuleSetConfiguration

TransformationRules getRuleSetConfiguration(long projectID)

Get the project ruleset configuration

Parameters:

projectID - the project id

Returns:

RuleSetConfiguration

setRuleSetConfiguration

void setRuleSetConfiguration(TransformationRules ruleSet)

Set the RuleSetConfiguration XML representation.

Parameters:

ruleSet - xml ruleset configuration

setRuleSetConfiguration

void setRuleSetConfiguration(TransformationRules ruleSet,
                           long projectID)

Set the RuleSetConfiguration XML representation.

Parameters:

ruleSet - xml ruleset configuration

projectID - the project id

getName

@NotNull
String getName()

Get the module name, same as in module.xml

Returns:

the module name string

isStarted

boolean isStarted()
                  throws de.espirit.firstspirit.server.ManagerNotFoundException

Method to get service state in gui methods. If we cast to ServiceImpl we get Proxy cast exception.

Returns:

service state

Throws:

de.espirit.firstspirit.server.ManagerNotFoundException

getAvailableRulesetsFromCache

Map<String,String> getAvailableRulesetsFromCache(long projectId)
                                                 throws IOException

Throws:

IOException

getAvailableRulesets

Map<String,String> getAvailableRulesets(long projectId)
                                        throws IOException

Throws:

IOException

getTransformationRules

TransformationRules getTransformationRules(String rulesetName,
                                         long projectId)
                                           throws IOException

Get the transformation rules for rule set name.

<ImportRuleSet name="the rule set name" description="">

Parameters:

rulesetName - the rule set String

projectId - the Project.getId()

Returns:

TransformationRules

Throws:

IOException

getProjectConfigFileName

String getProjectConfigFileName()

getRulesetConfigFileName

String getRulesetConfigFileName()

getProjectProperties

ProjectProperties getProjectProperties(long projectID)

setProjectProperties

void setProjectProperties(long projectID,
                        ProjectProperties properties)

clearCache

void clearCache()