public interface EntitlementDataFinderModule
Modifier and Type | Method and Description |
---|---|
EntitlementTreeNodeDTO |
getEntitlementData(String category,
String regex,
int limit)
Finds entitlement data values for given category type
|
EntitlementTreeNodeDTO |
getEntitlementDataByLevel(String category,
int level)
Finds entitlement data values for given category and for given hierarchical level
|
String |
getModuleName()
Gets name of this module
|
Set<String> |
getRelatedApplications()
Returns application names that are related with entitlement data that is retrieved by this
module
|
Set<String> |
getSupportedCategories()
Returns categories that are supported with entitlement data that is retrieved by this
module
|
int |
getSupportedHierarchicalLevels()
Returns supported hierarchical levels of that data must be retrieved.
|
void |
init(Properties properties)
Initializes data retriever module
|
boolean |
isAllApplicationRelated()
Defines whether entitlement data that is retrieved by this module,
is related with all applications
|
boolean |
isFullPathSupported()
Defines whether node
EntitlementTreeNodeDTO is defined by child node name
or by full path name with parent node names |
boolean |
isHierarchicalTree()
Defines whether tree nodes of
EntitlementTreeNodeDTO elements are shown
in UI by as a tree or flat structure |
boolean |
isSearchSupported()
Defines whether we can search the tree nodes of
EntitlementTreeNodeDTO elements
using regexp expressions |
void init(Properties properties) throws Exception
properties
- properties, that need to initialize the module. These properties can be
defined in entitlement.properties fileException
- throws when initialization is failedString getModuleName()
Set<String> getRelatedApplications()
Set<String> getSupportedCategories()
EntitlementTreeNodeDTO getEntitlementData(String category, String regex, int limit) throws Exception
category
- category of the entitlement data.regex
- regex values for filter out the return datalimit
- limit for filtered dataEntitlementTreeNodeDTO
Exception
- throws, if failsEntitlementTreeNodeDTO getEntitlementDataByLevel(String category, int level) throws Exception
category
- category of the entitlement data.level
- hierarchical level that data must be retrieved. If root level, value must be 1EntitlementTreeNodeDTO
Exception
- throws, if failsint getSupportedHierarchicalLevels()
boolean isFullPathSupported()
EntitlementTreeNodeDTO
is defined by child node name
or by full path name with parent node namesboolean isHierarchicalTree()
EntitlementTreeNodeDTO
elements are shown
in UI by as a tree or flat structureboolean isSearchSupported()
EntitlementTreeNodeDTO
elements
using regexp expressionsboolean isAllApplicationRelated()
Copyright © 2016 WSO2. All rights reserved.