com.filenet.bso.api.collaboration.store
Interface ApplicationsStore
- public interface ApplicationsStore
A class that implements the ApplicationsStore
interface returns the application
information (each represented by a Map
) in a variety of ways.
Method Summary |
java.util.Iterator |
getAllApplications()
Return all applications. |
java.util.Map |
getApplicationByID(java.lang.String id)
Get the application data by application id. |
java.util.Map |
getApplicationByLocaleAndGroup(java.util.Locale locale,
java.lang.String group)
Get an application by giving the locale and group name. |
java.util.Iterator |
getApplicationsInGroup(java.lang.String group)
Return all applications with the given group name. |
APPLICATION_XML
public static final java.lang.String APPLICATION_XML
APPLICATIONS_XML
public static final java.lang.String APPLICATIONS_XML
BASE_URL_XML
public static final java.lang.String BASE_URL_XML
EMAIL_DOMAIN_XML
public static final java.lang.String EMAIL_DOMAIN_XML
EMAIL_SENT_BY_XML
public static final java.lang.String EMAIL_SENT_BY_XML
EMAIL_SENT_BY_DOMAIN_XML
public static final java.lang.String EMAIL_SENT_BY_DOMAIN_XML
EMAIL_SENT_BY_NAME_XML
public static final java.lang.String EMAIL_SENT_BY_NAME_XML
EMAIL_TEMPLATE_MAP_ID_XML
public static final java.lang.String EMAIL_TEMPLATE_MAP_ID_XML
GROUP_XML
public static final java.lang.String GROUP_XML
ID_XML
public static final java.lang.String ID_XML
LOCALE_XML
public static final java.lang.String LOCALE_XML
PROCESS_ENGINE_APPLICATION_ID_XML
public static final java.lang.String PROCESS_ENGINE_APPLICATION_ID_XML
TIME_ZONE_XML
public static final java.lang.String TIME_ZONE_XML
URL_XML
public static final java.lang.String URL_XML
getApplicationByID
public java.util.Map getApplicationByID(java.lang.String id)
- Get the application data by application id.
- Parameters:
id
- the ID of the application to fetch- Returns:
- a map containing all the configured information on this application
getApplicationByLocaleAndGroup
public java.util.Map getApplicationByLocaleAndGroup(java.util.Locale locale,
java.lang.String group)
- Get an application by giving the locale and group name. The application in the
same group that is the "nearest" to the locale will be returned. The search for the nearest
locale is similar to Java's resource bundle search, which tries this order...
- language_country
- language
- defaultlanguage_defaultcountry
- defaultlanguage
- first application in group
For instance, if the locale is "fr_CH" (for French in Switzerland) and the default for the
server is "en_US" (for English in the US), then the locales for all applications in
this group will be checked in this order: "fr_CH", "fr", "en_US", "en" and the first application.
- Parameters:
locale
- the language/country to usegroup
- the name of the group of applications- Returns:
- a map containing all the configured information on this application
getApplicationsInGroup
public java.util.Iterator getApplicationsInGroup(java.lang.String group)
- Return all applications with the given group name.
- Parameters:
group
- the name of the group of applications to fetch- Returns:
- a collection of all application maps in the given group
getAllApplications
public java.util.Iterator getAllApplications()
- Return all applications.
- Returns:
- all application maps
Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.