com.sap.mw.jco

Interface IRepository

All Known Implementing Classes:

JCO.BasicRepository, JCO.Repository

public interface IRepository

Method Summary

void	addFunctionInterfaceToCache(IMetaData meta) Adds a function interface to the local cache.
void	addStructureDefinitionToCache(IMetaData meta) Adds a structure definition to the local cache.
String[]	getCachedFunctionInterfaces() Returns the names of the cached functions as a string array
String[]	getCachedStructureDefinitions() Returns the names of the cached structures as a string array
IMetaData	getFunctionInterface(String function_name) Returns the meta data for the passed function
IFunctionTemplate	getFunctionTemplate(String function_name) Returns the template for the function having the specified name
String	getName() Returns the name of the repository
IRepository	getNextRepository() Returns the next repository that will be used if a function or structure could not be found in this one.
IMetaData	getStructureDefinition(String structure_name) Returns the meta data for the passed structure
IMetaData	getTableDefinition(String table_name) Returns the meta data for the passed table
void	load(String filename) Load the repository to the specified file
void	removeFunctionInterfaceFromCache(String function_name) Removes a function interface from the local cache.
void	removeStructureDefinitionFromCache(String structure_name) Removes a function interface from the local cache.
void	save(String filename) Saves the repository to the specified file
void	setNextRepository(IRepository next) Sets the next repository that will be used if a function or structure could not be found in this one.

Method Detail

getName

public String getName()

Returns the name of the repository

Returns:

the name of the repository

getFunctionTemplate

public IFunctionTemplate getFunctionTemplate(String function_name)

Returns the template for the function having the specified name

Parameters:

function_name - the name of the function for which the template is being returned.

Returns:

the template for the function or null if not available.

getFunctionInterface

public IMetaData getFunctionInterface(String function_name)

Returns the meta data for the passed function

Parameters:

function_name - the name of the function for which the meta-data is being returned

Returns:

the meta data for the function

getStructureDefinition

public IMetaData getStructureDefinition(String structure_name)

Returns the meta data for the passed structure

Parameters:

structure_name - the name of the structure for which the meta-data is being returned

Returns:

the meta data for the structure

getTableDefinition

public IMetaData getTableDefinition(String table_name)

Returns the meta data for the passed table

Parameters:

table_name - the name of the table for which the meta-data is being returned

Returns:

the meta data for the structure

getNextRepository

public IRepository getNextRepository()

Returns the next repository that will be used if a function or structure could not be found in this one.

Returns:

the next repository to use or null if not set

setNextRepository

public void setNextRepository(IRepository next)

Sets the next repository that will be used if a function or structure could not be found in this one.

Parameters:

next - the next repository to use. Pass null if none.

save

public void save(String filename)
          throws IOException

Saves the repository to the specified file

Throws:

IOException

load

public void load(String filename)
          throws IOException

Load the repository to the specified file

Throws:

IOException

addFunctionInterfaceToCache

public void addFunctionInterfaceToCache(IMetaData meta)

Adds a function interface to the local cache. Implementations that do not use a cache just provide an empty method.

Parameters:

meta - the function interface to add to the cache

addStructureDefinitionToCache

public void addStructureDefinitionToCache(IMetaData meta)

Adds a structure definition to the local cache. Implementations that do not use a cache just provide an empty method.

Parameters:

meta - the meta-data of the structure to add to the cache

removeFunctionInterfaceFromCache

public void removeFunctionInterfaceFromCache(String function_name)

Removes a function interface from the local cache. Implementations that do not use a cache just provide an empty method.

Parameters:

function_name - the name of the function to be removed from the cache

removeStructureDefinitionFromCache

public void removeStructureDefinitionFromCache(String structure_name)

Removes a function interface from the local cache. Implementations that do not use a cache just provide an empty method.

Parameters:

structure_name - the name of the structure to be removed from the cache

getCachedFunctionInterfaces

public String[] getCachedFunctionInterfaces()

Returns the names of the cached functions as a string array

Returns:

a string array of the cached functions or null if the cache is empty or not implemented

getCachedStructureDefinitions

public String[] getCachedStructureDefinitions()

Returns the names of the cached structures as a string array

Returns:

a string array of the cached structures or null if the cache is empty or not implemented