de.innovationgate.wga.server.api

Class App

java.lang.Object

de.innovationgate.wga.server.api.Database

de.innovationgate.wga.server.api.App

Direct Known Subclasses:

Plugin

public class App
extends Database

Object representing an OpenWGA application and its services

Field Summary

Fields

Modifier and Type	Field and Description
HDBModel	HDBModel

Fields inherited from class de.innovationgate.wga.server.api.Database

QUERYATT_ALLLANGUAGES, QUERYATT_CACHE, QUERYATT_DB, QUERYATT_HIGHLIGHT, QUERYATT_INCLUDECURRENT, QUERYATT_LANGUAGE, QUERYATT_MAX, QUERYATT_ONLYPUBLISHED, QUERYATT_OPTIONS, QUERYATT_ROLE, QUERYOUT_SIMPLIFIED_QUERY

Method Summary

Methods

Modifier and Type	Method and Description
Context	context() TMLContext handling for App
Context	context(java.lang.String expression)
Context	context(java.lang.String expression, boolean returnContextOnError)
Context	context(de.innovationgate.webgate.api.WGContent c)
ApplicationEventBuilder	createEvent(java.util.List<? extends java.lang.Object> qualifiers)
ApplicationEventBuilder	createEvent(java.lang.String eventPathStr)
ApplicationEventBuilder	createEvent(java.lang.String eventPathStr, java.util.Map<java.lang.Object,java.lang.Object> params)
Design	design() Returns the design context of the app
Design	design(java.lang.String refString) Returns the design context for a design resource in this app
void	fireEvent(java.lang.String eventPathStr)
void	fireEvent(java.lang.String eventPathStr, java.util.Map<java.lang.Object,java.lang.Object> params)
java.util.List<java.lang.String>	getAreaNames() Returns a list of names of the website areas of this app
java.lang.String	getBaseURL()
java.util.List<java.lang.String>	getContentTypeNames() Returns a list of names of the content types of this app
java.lang.Object	getGlobal(java.lang.String name) Returns a TMLScript global that is available for the current app This method allows to retrieve TMLScript globals with their name as method parameter.
Context	getHomepage()
java.lang.String	getHomepageURL()
java.util.List<java.lang.String>	getLanguageNames() Returns a list of names of the languages (i.e. language codes) of this app
java.util.List<java.lang.String>	getUserRoles() Returns the user roles of the currently logged in user on the application
boolean	isLuceneIndexed() Returns if a Lucene fulltext index is available for this application
Lucene	lucene() Returns a lucene object with this application in context.
void	managedGlobal(java.lang.String name, Design design, ManagedGlobalConfig config) Registers a managed TMLScript app global variable, which will get created on demand from the TMLScript module of this Designs current base reference.
UserProfile	userProfile() Returns the user profile associated with the current user for this app.

Methods inherited from class de.innovationgate.wga.server.api.Database

buildDefaultQueryParams, createTMLContext, db, domain, equals, getAccessLevel, getDbKey, getPublisherOption, getUserName, hashCode, isAnonymous, isAuthor, isChiefEditor, isEditor, isManager, isOpen, isReader, isUserMemberOf, makeQueryParameterName, query, query, query, query, reopen

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

HDBModel

public HDBModel HDBModel

Method Detail

getGlobal

public java.lang.Object getGlobal(java.lang.String name)
                           throws de.innovationgate.webgate.api.WGException

Returns a TMLScript global that is available for the current app This method allows to retrieve TMLScript globals with their name as method parameter. It can retrieve normal globals just like globals of design scope. This might contain native TMLScript objects which are not usable from Java.

Parameters:

name - Name the global

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGException

design

public Design design()
              throws de.innovationgate.webgate.api.WGException

Returns the design context of the app

Throws:

UnavailableResourceException

de.innovationgate.webgate.api.WGException

design

public Design design(java.lang.String refString)
              throws de.innovationgate.webgate.api.WGException

Returns the design context for a design resource in this app

Parameters:

refString - The name of the design resource

Throws:

UnavailableResourceException

de.innovationgate.webgate.api.WGException

getUserRoles

public java.util.List<java.lang.String> getUserRoles()
                                              throws de.innovationgate.webgate.api.WGException

Returns the user roles of the currently logged in user on the application

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

lucene

public Lucene lucene()
              throws de.innovationgate.webgate.api.WGException

Returns a lucene object with this application in context. Throws an exception if the application is not contained in Lucene fulltext index.

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

isLuceneIndexed

public boolean isLuceneIndexed()
                        throws de.innovationgate.webgate.api.WGException

Returns if a Lucene fulltext index is available for this application

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

getAreaNames

public java.util.List<java.lang.String> getAreaNames()
                                              throws de.innovationgate.webgate.api.WGException

Returns a list of names of the website areas of this app

Throws:

de.innovationgate.webgate.api.WGException

getLanguageNames

public java.util.List<java.lang.String> getLanguageNames()
                                                  throws de.innovationgate.webgate.api.WGException

Returns a list of names of the languages (i.e. language codes) of this app

Throws:

de.innovationgate.webgate.api.WGException

getContentTypeNames

public java.util.List<java.lang.String> getContentTypeNames()
                                                     throws de.innovationgate.webgate.api.WGException

Returns a list of names of the content types of this app

Throws:

de.innovationgate.webgate.api.WGException

getBaseURL

public java.lang.String getBaseURL()
                            throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

getHomepage

public Context getHomepage()
                    throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

getHomepageURL

public java.lang.String getHomepageURL()
                                throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

createEvent

public ApplicationEventBuilder createEvent(java.util.List<? extends java.lang.Object> qualifiers)
                                    throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

createEvent

public ApplicationEventBuilder createEvent(java.lang.String eventPathStr)
                                    throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

createEvent

public ApplicationEventBuilder createEvent(java.lang.String eventPathStr,
                                  java.util.Map<java.lang.Object,java.lang.Object> params)
                                    throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

fireEvent

public void fireEvent(java.lang.String eventPathStr,
             java.util.Map<java.lang.Object,java.lang.Object> params)
               throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

fireEvent

public void fireEvent(java.lang.String eventPathStr)
               throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

managedGlobal

public void managedGlobal(java.lang.String name,
                 Design design,
                 ManagedGlobalConfig config)
                   throws de.innovationgate.webgate.api.WGException

Registers a managed TMLScript app global variable, which will get created on demand from the TMLScript module of this Designs current base reference. When called from TMLScript this method is "wrapped" to the following signature: managedGlobal(String name, DesignLocator, JavaScriptObject)

Parameters:

name -

scope - The creation scope which determines, for which scope entity individual global objects will be provided. For example: Scope ObjectScope.PORTLET creates individual global objects for every request.

Throws:

de.innovationgate.webgate.api.WGException

userProfile

public UserProfile userProfile()
                        throws de.innovationgate.webgate.api.WGException

Returns the user profile associated with the current user for this app. May return null if the current user has no profile or the environment does not have the necessary profile assocation information.

Throws:

de.innovationgate.webgate.api.WGException

context

public Context context()
                throws de.innovationgate.webgate.api.WGException

TMLContext handling for App

Throws:

de.innovationgate.webgate.api.WGException

context

public Context context(de.innovationgate.webgate.api.WGContent c)
                throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

context

public Context context(java.lang.String expression)
                throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

context

public Context context(java.lang.String expression,
              boolean returnContextOnError)
                throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException