B.2. Klaros-Scripting API Reference

B.2. Klaros-Scripting API Reference
	Appendix B. Model API Reference

B.2.1. Package de.verit.klaros.scripting

B.2.1.1. Class KlarosContext
B.2.1.2. Class KlarosQueryFactory
B.2.1.3. Interface KlarosScript

B.2.1.1. Class KlarosContext

Context to provide all methods to the user to add own objects to the event context.

B.2.1.1.1. Synopsis

 
                     public class de.verit.klaros.scripting.KlarosContextimplements, de.verit.klaros.scripting.context.IKlarosContext {
// Public Constructors  public KlarosContext(org.jboss.seam.contexts.Context context,
                       de.verit.klaros.core.persistent.Configuration activeProject,
                       de.verit.klaros.scripting.KlarosQueryFactory factory,
                       de.verit.klaros.scripting.model.ParameterContext parameters);
                     

                       public KlarosContext(org.jboss.seam.contexts.Context context,
                       de.verit.klaros.core.persistent.Configuration activeProject,
                       de.verit.klaros.scripting.KlarosQueryFactory factory,
                       de.verit.klaros.scripting.model.ParameterContext parameters,
                       java.util.Locale locale);
                     
// Public Methods  public void add(java.lang.String name,
                  java.lang.Object value);
                     

                       public void addParameter(java.lang.String name,
                           java.lang.Object value,
                           de.verit.klaros.scripting.model.ParameterType type);
                     

                       public java.util.List<?> executeParameterizedQuery(java.lang.String query);
                     

                       public java.util.List<?> executeQuery(java.lang.String query);
                     

                       public de.verit.klaros.core.model.KlarosConfiguration getActiveProject();
                     

                       public java.util.Locale getLocale();
                     

                       public de.verit.klaros.contentrepository.parameter.Parameter getParameter(java.lang.String name);
                     

                       public java.lang.Object getParameterValue(java.lang.String name);
                     

                       public void setLocale(java.util.Locale locale);
                     
}

Methods inherited from java.lang.Object: equals , getClass , hashCode , notify , notifyAll , toString , wait

B.2.1.1.2. KlarosContext(Context, Configuration, KlarosQueryFactory, ParameterContext)

public KlarosContext(org.jboss.seam.contexts.Context context,
                     de.verit.klaros.core.persistent.Configuration activeProject,
                     de.verit.klaros.scripting.KlarosQueryFactory factory,
                     de.verit.klaros.scripting.model.ParameterContext parameters);

Create a KlarosContext.

Parameters
context	Gets passed by the relating servlet.
activeProject	The active project if available.

B.2.1.1.3. KlarosContext(Context, Configuration, KlarosQueryFactory, ParameterContext, Locale)

public KlarosContext(org.jboss.seam.contexts.Context context,
                     de.verit.klaros.core.persistent.Configuration activeProject,
                     de.verit.klaros.scripting.KlarosQueryFactory factory,
                     de.verit.klaros.scripting.model.ParameterContext parameters,
                     java.util.Locale locale);

Create a KlarosContext.

Parameters
context	Gets passed by the relating servlet.
activeProject	The active project if available.

B.2.1.1.4. add(String, Object)

public void add(java.lang.String name,
                java.lang.Object value);

Specified by: Method add in interface IKlarosContext

Add a new object with the give key to the event context.

B.2.1.1.5. addParameter(String, Object, ParameterType)

public void addParameter(java.lang.String name,
                         java.lang.Object value,
                         de.verit.klaros.scripting.model.ParameterType type);

Specified by: Method addParameter in interface IKlarosContext

Add a new parameter to the ParameterContext.

B.2.1.1.6. executeParameterizedQuery(String)

public java.util.List<?> executeParameterizedQuery(java.lang.String query);

Specified by: Method executeParameterizedQuery in interface IKlarosContext

Execute the given query with the Parameters from the ParameterContext.

B.2.1.1.7. executeQuery(String)

public java.util.List<?> executeQuery(java.lang.String query);

Specified by: Method executeQuery in interface IKlarosContext

Execute the given query.

B.2.1.1.8. getActiveProject()

public de.verit.klaros.core.model.KlarosConfiguration getActiveProject();

Specified by: Method getActiveProject in interface IKlarosContext

B.2.1.1.9. getLocale()

public java.util.Locale getLocale();

Specified by: Method getLocale in interface IKlarosContext

B.2.1.1.10. getParameter(String)

public de.verit.klaros.contentrepository.parameter.Parameter getParameter(java.lang.String name);

Specified by: Method getParameter in interface IKlarosContext

B.2.1.1.11. getParameterValue(String)

public java.lang.Object getParameterValue(java.lang.String name);

Specified by: Method getParameterValue in interface IKlarosContext

B.2.1.1.12. setLocale(Locale)

public void setLocale(java.util.Locale locale);

Specified by: Method setLocale in interface IKlarosContext

B.2.1.2. Class KlarosQueryFactory

This factory lets the user execute queries.

B.2.1.2.1. Synopsis

 
                     public class de.verit.klaros.scripting.KlarosQueryFactory {
// Public Static Fields  public static final java.lang.String WRAPPER_PREFIX = "Klaros";
                     
// Public Constructors  public KlarosQueryFactory(org.hibernate.Session session);
                     
// Public Methods  public java.util.List<?> execute(java.lang.String query);
                     

                       public java.util.List<?> execute(java.lang.String query,
                                       de.verit.klaros.scripting.model.ParameterContext params);
                     
}

Methods inherited from java.lang.Object: equals , getClass , hashCode , notify , notifyAll , toString , wait

B.2.1.2.2. KlarosQueryFactory(Session)

public KlarosQueryFactory(org.hibernate.Session session);

Create a KlarosQueryFactory.

Parameters
session	Passed by the relating servlet.

B.2.1.2.3. WRAPPER_PREFIX

public static final java.lang.String WRAPPER_PREFIX = "Klaros";

The prefix for klaros interfaces.

B.2.1.2.4. execute(String)

public java.util.List<?> execute(java.lang.String query);

Prepares the given query string with our KlarosOdaQuery and returns a KlarosList with the results of the query.

Parameters
query	the query
return	the list of query results

B.2.1.2.5. execute(String, ParameterContext)

public java.util.List<?> execute(java.lang.String query,
                                     de.verit.klaros.scripting.model.ParameterContext params);

Prepares the given query string with our KlarosOdaQuery and returns a KlarosList with the results of the query.

Parameters
query	the query
params	the parameters
return	the list<?>

B.2.1.3. Interface KlarosScript

Public interface that all seam-pdf template scripts must implement be work properly.

B.2.1.3.1. Synopsis

 
                     public interface de.verit.klaros.scripting.KlarosScript {
// Public Methods  public void execute(de.verit.klaros.scripting.KlarosContext context);
                     
}

B.2.1.3.2. execute(KlarosContext)

public void execute(de.verit.klaros.scripting.KlarosContext context);

This functions gets called by the seam-pdf servlet to execute the script.

Parameters
context	The event context to provide all needed functions, properties and objects.


Appendix B. Model API Reference		B.2.2. Package de.verit.klaros.scripting.context