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 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

Modifier and Type	Method and Description
Design	design() Returns the design context of the app
Design	design(String refString) Returns the design context for a design resource in this app
List<String>	getAreaNames() Returns a list of names of the website areas of this app
List<String>	getContentTypeNames() Returns a list of names of the content types of this app
List<String>	getLanguageNames() Returns a list of names of the languages (i.e. language codes) of this app
List<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.

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

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

Methods inherited from class java.lang.Object

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

Method Detail

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(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 List<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 List<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 List<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 List<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