oracle.apps.fnd.applcore.socialnetwork.model.util
Class ModuleFilter

java.lang.Object
  oracle.apps.fnd.applcore.socialnetwork.model.util.ModuleFilter

public class ModuleFilter
extends java.lang.Object

A filter which knows how to lookup the module type/module key combination and use that to determine if another module id fits within the children of the module type+key. When no more filter tests are to be run then the closeFilter method must be called to perform cleanup of internal references. Expected usage: ModuleFilter filter = new ModuleFilter(moduleType, moduleKey). // run filter tests try { boolean passesFilter = filter.isModuleWithinFilter(testModuleId); } finally { // always cleanup filter.cleanup(); }

Since:

11.1.1.7.0

Version:

$Header: atgpf/applcore/applications/SocialNetwork/Model/src/oracle/apps/fnd/applcore/socialnetwork/model/util/ModuleFilter.java /st_atgpf_pt-11.1.1.7.0/3 2013/02/25 14:08:29 pacross Exp $

Constructor Summary

ModuleFilter(java.lang.String moduleType, java.lang.String moduleKey)
Default Constructor.

Method Summary

void	closeFilter() All instances of ModuleFilter should call this before the object is no longer used to perform cleanup of internal references.
java.lang.String[]	findFamilyAppInfoForModule(java.lang.String moduleId) Find the family information for the module provided.
java.util.Map<oracle.jbo.LocaleContext,java.lang.String>	getModuleTranslations(java.lang.String moduleId, oracle.jbo.LocaleContext[] locales) Retrieve the list of module user name translations for the locales provided.
boolean	isModuleWithinFilter(java.lang.String filterModuleId) Test to see if the module id passed in fits within the moduleType+moduleKey heirarchy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModuleFilter

public ModuleFilter(java.lang.String moduleType,
                    java.lang.String moduleKey)

Default Constructor.

Parameters:

moduleType - the module type to filter with. (for example: APPLICATION).

moduleKey - the module key to filter with (FND).

Method Detail

closeFilter

public void closeFilter()

All instances of ModuleFilter should call this before the object is no longer used to perform cleanup of internal references.

isModuleWithinFilter

public boolean isModuleWithinFilter(java.lang.String filterModuleId)

Test to see if the module id passed in fits within the moduleType+moduleKey heirarchy.

Parameters:

filterModuleId - the module id to test.

Returns:

true iff the module id is a child of the module represented by moduleType+moduleKey.

findFamilyAppInfoForModule

public java.lang.String[] findFamilyAppInfoForModule(java.lang.String moduleId)

Find the family information for the module provided.

Parameters:

moduleId - module id to find the family for.

Returns:

an array containing {family module key, family module name, family module id}.

getModuleTranslations

public java.util.Map<oracle.jbo.LocaleContext,java.lang.String> getModuleTranslations(java.lang.String moduleId,
                                                                                      oracle.jbo.LocaleContext[] locales)

Retrieve the list of module user name translations for the locales provided.

Parameters:

moduleId - the id of the module to get the translations for.

locales - the locales to get the translated values of

Returns:

the translated user names for the module provided.