com.metamatrix.admin.api.objects
Interface ScriptsContainer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

MMScriptsContainer

public interface ScriptsContainer
extends java.io.Serializable

Contains all information nessecary to save the scripts that will be run by a MetaMatrix utility to load or refresh the data resident in a Materialized View.

Users can get the contents of each file and save each with the filename associated with it or, more easily, users can save all files to a local folder. (See saveAllToDirectory(java.lang.String, com.metamatrix.admin.api.objects.AdminOptions))

Since:

4.3

Method Summary

java.util.Collection	getFileNames() Get the file names of all scripts in this container.
void	saveAllToDirectory(java.lang.String directoryLocation, AdminOptions options) Save all of the scripts contained to the specified local directory.

Method Detail

getFileNames

java.util.Collection getFileNames()

Get the file names of all scripts in this container.

Returns:

The Collection of String file names of all scripts in this container. This collection may be empty if an error has occured.

Since:

4.3

saveAllToDirectory

void saveAllToDirectory(java.lang.String directoryLocation,
                        AdminOptions options)
                        throws AdminException

Save all of the scripts contained to the specified local directory.

Parameters:

directoryLocation - the directory location to save the contained scripts. Must be accessable from where this code is running.

options - Specify whether to AdminOptions.OnConflict.OVERWRITE or AdminOptions.OnConflict.EXCEPTION (default) when script files exist in the directoryLocation.

Throws:

AdminException - if there's an error saving the files.

Since:

4.3