org.nuclos.api.ide

Interface SourceItemFacadeRemote

public interface SourceItemFacadeRemote

Remote facade for supporting java event support sources synchronization to the client.

Since:

Nuclos 3.13

Author:

Thomas Pasch

Method Summary

Modifier and Type	Method and Description
void	forceRuleCompilation() Force a new rule compilation on the server.
java.net.URL	getDownloadURL(java.lang.String qualifiedClassname, boolean src) Get an URL that can be used for downloading the java source of an source item (business object or event source).
INuclosApi	getNuclosApi() Get info about the nuclos API version.
java.net.URL	getNuclosApiDownloadURL(java.lang.String jarFileName) Get an URL that can be used for downloading the nuclos api jar file.
ISourceItem	getTree(SourceType type, java.lang.String qualifiedPackagenameAsRoot, boolean includeOldApiRules) Get the source items (beginning with root), containing all source items (of the given type) that are defined in the nuclos instance.
ISourceItem	uploadSourceItem(ISourceItem item, boolean isOldRule, byte[] content) Upload the given java source item.

Method Detail

getTree

ISourceItem getTree(SourceType type,
                    java.lang.String qualifiedPackagenameAsRoot,
                    boolean includeOldApiRules)
             throws java.lang.IllegalAccessException

Get the source items (beginning with root), containing all source items (of the given type) that are defined in the nuclos instance.

Parameters:

type - SourceType of SourceItem. By definition null means 'all types for SourceItems'.

qualifiedPackagenameAsRoot - Root node of the subtree of SourceItems to retrieve. By definition null means 'complete tree, beginning at root'. (If qualifiedPackagenameAsRoot happens to be a Classname, the result is always null.)

includeOldApiRules - true to include 'old rules'

Returns:

Root node with up-to-date subtree. (Normally the result is not a copy of the given parameter root.)

Throws:

java.lang.IllegalAccessException

getDownloadURL

java.net.URL getDownloadURL(java.lang.String qualifiedClassname,
                            boolean src)
                     throws java.lang.IllegalAccessException

Get an URL that can be used for downloading the java source of an source item (business object or event source).

Throws:

java.lang.IllegalAccessException

getNuclosApi

INuclosApi getNuclosApi()
                 throws java.lang.IllegalAccessException

Get info about the nuclos API version.

Returns:

Nuclos API information

Throws:

java.lang.IllegalAccessException

getNuclosApiDownloadURL

java.net.URL getNuclosApiDownloadURL(java.lang.String jarFileName)
                              throws java.lang.IllegalAccessException

Get an URL that can be used for downloading the nuclos api jar file.

Throws:

java.lang.IllegalAccessException

uploadSourceItem

ISourceItem uploadSourceItem(ISourceItem item,
                             boolean isOldRule,
                             byte[] content)
                      throws java.lang.IllegalAccessException

Upload the given java source item.

Parameters:

item -

isOldRule - true if this rule is part of the 'old rule API'

content -

Returns:

The ISourceItem as saved on the server side. This is important as the SourceScanner will add a prefix comment to the saved source. If the this return value is different form the parameter item given, the IDE must reload the source. It is recommended to reload after forceRuleCompilation().

Throws:

java.lang.IllegalAccessException

forceRuleCompilation

void forceRuleCompilation()

Force a new rule compilation on the server.

This method is called after all (altered) java source items have been uploaded with uploadSourceItem(ISourceItem, boolean, byte[]).