de.bensoft.acis.core

Interface ActionPackage

public interface ActionPackage

Used to represent an ActionPackage.
An ActionPackage can contain several Actions which belong to the same type of actions or are related to each other (like an application). The Actions share the same Environment.
An ActionPackage may not been added if the minimum ACIS library version specified in getMinimumRequiredLibraryVersion() is higher than the version of the executing ACIS system (see ACIS.LIBRARY_VERSION).

Method Summary

Modifier and Type	Method and Description
Action[]	getActions(Language language) Returns an array of Actions.
java.lang.String	getDescription() Returns a short description of what the Actions in the package do.
java.util.Locale	getLocale() Returns a Locale for which the Actions are applicable.
int	getMinimumRequiredLibraryVersion() Returns the minimal required library version for this ActionPackage to work.
java.lang.String	getName() Returns the name of the ActionPackage in Java-style (like com.example.acis.actions.whatever).

Method Detail

getName

java.lang.String getName()

Returns the name of the ActionPackage in Java-style (like com.example.acis.actions.whatever).

Returns:

The name.

getDescription

java.lang.String getDescription()

Returns a short description of what the Actions in the package do.

Returns:

The description.

getLocale

java.util.Locale getLocale()

Returns a Locale for which the Actions are applicable. Usually this Locale represents the Language the Actions give output in.
Actions cannot be language-independent.

Returns:

The language Locale.

getMinimumRequiredLibraryVersion

int getMinimumRequiredLibraryVersion()

Returns the minimal required library version for this ActionPackage to work.
Version is in format "yyMMdd". For all versions, return 0.

Returns:

The version code of the minimum required ACIS system (e.g. 170810).

getActions

Action[] getActions(Language language)
             throws ActionMalformedException

Returns an array of Actions.

Parameters:

language - The Language the ACIS system to implement the Actions in uses.

Returns:

The array of Actions.

Throws:

ActionMalformedException - When one or more Actions are malformed.