de.uplanet.lucy.server.scripting.velocity.callables
Class VelocityRtCache

java.lang.Object
  extended by de.uplanet.lucy.server.scripting.velocity.callables.VelocityRtCache

@VelocityCallable(value="singleton")
public final class VelocityRtCache
extends java.lang.Object

Version:
$Revision: 76926 $

Constructor Summary
VelocityRtCache()
           
 
Method Summary
 ApplicationInfo getApplication(java.lang.String p_strAppGuid)
          Get the application with the given unique identifier.
 java.util.Map<java.lang.String,ApplicationInfo> getApplications()
          Get all applications.
static java.util.List<ApplicationInfo> getApplications(IFilter<ApplicationInfo> p_filter)
          Get applications that match a given filter.
static DataGroupInfo getDataGroup(java.lang.String p_strDgGuid)
          Get the data group with the given unique identifier.
static java.util.Map<java.lang.String,DataGroupInfo> getDataGroups()
          Get all data groups.
static java.util.List<DataGroupInfo> getDataGroups(IFilter<DataGroupInfo> p_filter)
          Get data groups that match a given filter.
static FieldInfo getField(java.lang.String p_strFieldGuid)
          Get the field with the given unique identifier.
static java.util.Map<java.lang.String,FieldInfo> getFields()
          Get all fields.
static java.util.List<FieldInfo> getFields(IFilter<FieldInfo> p_filter)
          Get all FieldInfo objects that are accepted by the given filter.
 ApplicationInfo getFirstApplication(IFilter<ApplicationInfo> p_filter)
          Get first application that matches a given filter.
static DataGroupInfo getFirstDataGroup(IFilter<DataGroupInfo> p_filter)
          Get first data group that matches de.uplanet.util.filter.IFilter.
static FieldInfo getFirstField(IFilter<FieldInfo> p_filter)
          Get the first FieldInfo object that is accepted by the given filter.
static PageInfo getFirstPage(IFilter<PageInfo> p_filter)
          Get the first PageInfo object that is accepted by the given filter.
static PageInfo getPage(java.lang.String p_strPageGuid)
          Get the page with the given unique identifier.
static java.util.Map<java.lang.String,PageInfo> getPages()
          Get all pages.
static java.util.List<PageInfo> getPages(IFilter<PageInfo> p_filter)
          Get all PageInfo objects that are accepted by the given filter.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VelocityRtCache

public VelocityRtCache()
Method Detail

getApplications

public java.util.Map<java.lang.String,ApplicationInfo> getApplications()
                                                                throws de.uplanet.lucy.server.rtcache.RtCacheException
Get all applications.

Returns:
A map that contains all applications.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getApplication

public ApplicationInfo getApplication(java.lang.String p_strAppGuid)
                               throws de.uplanet.lucy.server.rtcache.RtCacheException
Get the application with the given unique identifier.

Parameters:
p_strAppGuid - The application's unique identifier.
Returns:
The requested application, or null if it was not found.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getFirstApplication

public ApplicationInfo getFirstApplication(IFilter<ApplicationInfo> p_filter)
                                    throws de.uplanet.lucy.server.rtcache.RtCacheException
Get first application that matches a given filter.

Parameters:
p_filter - The filter to be applied (see ObjectFactory#createFilter(String)).
Returns:
ApplicationInfo list from first matching application.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getApplications

public static java.util.List<ApplicationInfo> getApplications(IFilter<ApplicationInfo> p_filter)
                                                       throws de.uplanet.lucy.server.rtcache.RtCacheException
Get applications that match a given filter.

Parameters:
p_filter - The filter to be applied (see ObjectFactory#createFilter(String)).
Returns:
ApplicationInfo list of applications that matched the filter.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getDataGroups

public static java.util.Map<java.lang.String,DataGroupInfo> getDataGroups()
                                                                   throws de.uplanet.lucy.server.rtcache.RtCacheException
Get all data groups.

Returns:
a map of all data groups.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getDataGroup

public static DataGroupInfo getDataGroup(java.lang.String p_strDgGuid)
                                  throws de.uplanet.lucy.server.rtcache.RtCacheException
Get the data group with the given unique identifier.

Parameters:
p_strDgGuid - The data group's unique identifier.
Returns:
The requested data group, or null if it was not found.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getFirstDataGroup

public static DataGroupInfo getFirstDataGroup(IFilter<DataGroupInfo> p_filter)
                                       throws de.uplanet.lucy.server.rtcache.RtCacheException
Get first data group that matches de.uplanet.util.filter.IFilter.

Parameters:
p_filter - The filter to be applied (see ObjectFactory#createFilter(String)).
Returns:
DataGroupInfo list of first matching data group.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getDataGroups

public static java.util.List<DataGroupInfo> getDataGroups(IFilter<DataGroupInfo> p_filter)
                                                   throws de.uplanet.lucy.server.rtcache.RtCacheException
Get data groups that match a given filter.

Parameters:
p_filter - The filter to be applied (see ObjectFactory#createFilter(String)).
Returns:
DataGroupInfo list of data groups that matched the filter.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getFields

public static java.util.Map<java.lang.String,FieldInfo> getFields()
                                                           throws de.uplanet.lucy.server.rtcache.RtCacheException
Get all fields.

Returns:
a map of all fields.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getField

public static FieldInfo getField(java.lang.String p_strFieldGuid)
                          throws de.uplanet.lucy.server.rtcache.RtCacheException
Get the field with the given unique identifier.

Parameters:
p_strFieldGuid - The field's unique identifier.
Returns:
The requested field, or null if it was not found.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getFirstField

public static FieldInfo getFirstField(IFilter<FieldInfo> p_filter)
                               throws de.uplanet.lucy.server.rtcache.RtCacheException
Get the first FieldInfo object that is accepted by the given filter.

Parameters:
p_filter - The filter to be applied (see ObjectFactory#createFilter(String)).
Returns:
A matching FieldInfo object, or null if no match was found.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getFields

public static java.util.List<FieldInfo> getFields(IFilter<FieldInfo> p_filter)
                                           throws de.uplanet.lucy.server.rtcache.RtCacheException
Get all FieldInfo objects that are accepted by the given filter.

Parameters:
p_filter - The filter to be applied (see ObjectFactory#createFilter(String)).
Returns:
The FieldInfo objects that are accepted by the given filter.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getPages

public static java.util.Map<java.lang.String,PageInfo> getPages()
                                                         throws de.uplanet.lucy.server.rtcache.RtCacheException
Get all pages.

Returns:
A map of all pages.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getPage

public static PageInfo getPage(java.lang.String p_strPageGuid)
                        throws de.uplanet.lucy.server.rtcache.RtCacheException
Get the page with the given unique identifier.

Parameters:
p_strPageGuid - The pages's unique identifier.
Returns:
The requested page, or null if it was not found.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getFirstPage

public static PageInfo getFirstPage(IFilter<PageInfo> p_filter)
                             throws de.uplanet.lucy.server.rtcache.RtCacheException
Get the first PageInfo object that is accepted by the given filter.

Parameters:
p_filter - The filter to be applied (see ObjectFactory#createFilter(String)).
Returns:
A matching PageInfo object, or null if no match was found.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException

getPages

public static java.util.List<PageInfo> getPages(IFilter<PageInfo> p_filter)
                                         throws de.uplanet.lucy.server.rtcache.RtCacheException
Get all PageInfo objects that are accepted by the given filter.

Parameters:
p_filter - The filter to be applied (see ObjectFactory#createFilter(String)).
Returns:
The PageInfo objects that are accepted by the given filter.
Throws:
de.uplanet.lucy.server.rtcache.RtCacheException


Last updated: 2011-01-27
Copyright 2000-2010 United Planet. All Rights Reserved.