public interface ViewCriteriaManager
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DFLT_VIEW_CRITERIA_NAME |
static java.lang.String |
IMPLICIT_VIEW_CRITERIA_NAME |
static java.lang.String |
QUICKSEARCH_VIEW_CRITERIA_NAME |
Modifier and Type | Method and Description |
---|---|
void |
applyViewCriteria(ViewCriteria vc)
Apply the view criteria passed as the argument.
|
void |
applyViewCriteria(ViewCriteria vc,
boolean bAppend)
Apply the view crtieria passed as the argument.
|
CriteriaClauses |
buildViewCriteriaClauses(ViewCriteria vc)
This method is used by the framework to generate a query clause for a
particular view criteria.
|
void |
clearViewCriterias()
Clear all view criteria, both applied and unapplied help by this
manager
|
void |
criteriaChanged(ViewCriteria vc)
The criteria manager can track changes to applied view criteria.
|
java.lang.String[] |
getAllViewCriteriaNames()
Returns a list of both applied and unapplied view criterias managed
by this object.
|
ViewCriteria[] |
getAllViewCriterias()
Returns a list of both applied and unapplied view criterias managed
by this object.
|
java.lang.String[] |
getApplyViewCriteriaNames() |
ViewCriteria[] |
getApplyViewCriterias(int criteriaMode)
Return a list of applied view criteria that have the mode passed in the argument
turned on.
|
java.lang.String[] |
getAvailableViewCriteriaNames()
Returns a list of view criteria names that are unapplied and managed
by this object
|
ViewCriteria |
getViewCriteria()
Returns the default view criteria of the manager.
|
ViewCriteria |
getViewCriteria(java.lang.String name)
Returns a reference to the view criteria with a specific name
if it is found.
|
java.lang.String |
getViewCriteriaClause(boolean forQuery)
This method is used by the framework to generate a query clause for the
applied view criterias.
|
void |
putViewCriteria(java.lang.String name,
ViewCriteria vc)
Add a view criteria to be managed by this object
|
boolean |
removeApplyViewCriteriaName(java.lang.String name)
Unapplied the view criteria if it is applied.
|
ViewCriteria |
removeViewCriteria(java.lang.String name)
Removes the view criteria from this manager.
|
void |
resetCriteria(ViewCriteria vc)
Resets a view criteria to the state as defined in the View Definition.
|
void |
setApplyViewCriteriaName(java.lang.String name)
Apply the view criteria name passed as the argument.
|
void |
setApplyViewCriteriaName(java.lang.String name,
boolean bAppend)
Apply the view crtieria name passed as the argument.
|
void |
setApplyViewCriteriaNames(java.lang.String[] names)
Apply a set of view criteria names passed as the argument.
|
void |
setCurrentUnionViewCriteriaName(java.lang.String vcName) |
static final java.lang.String DFLT_VIEW_CRITERIA_NAME
static final java.lang.String IMPLICIT_VIEW_CRITERIA_NAME
static final java.lang.String QUICKSEARCH_VIEW_CRITERIA_NAME
ViewCriteria getViewCriteria(java.lang.String name)
name
- view criteria nameViewCriteria getViewCriteria()
DFLT_VIEW_CRITERIA_NAME
then it is considered to
be the default. The default name is also assigned when a view criteria with
a null name is applied.ViewCriteria[] getAllViewCriterias()
java.lang.String[] getAllViewCriteriaNames()
java.lang.String[] getAvailableViewCriteriaNames()
void putViewCriteria(java.lang.String name, ViewCriteria vc)
name
- Name of the view criteriavc
- view criteria referencevoid clearViewCriterias()
ViewCriteria removeViewCriteria(java.lang.String name)
removeApplyViewCriteriaName
API.name
- The view criteria name that needs to be removedboolean removeApplyViewCriteriaName(java.lang.String name)
name
- The view criteria name that need to be unapplied.true
if the view criteria was found to be applied,
false
otherwise.void applyViewCriteria(ViewCriteria vc)
vc
- the criteria to be applied.void applyViewCriteria(ViewCriteria vc, boolean bAppend)
bAppend
is true the passed view criteria will be applied in addition
to the existing ones. If bAppend
is false this method is
identical to applyViewCriteria(ViewCriteria)
vc
- the criteria to be appliedbAppend
- pass true
if the view criteria needs to be appended to
the applied list otherwise the list is cleared out.void setApplyViewCriteriaName(java.lang.String name)
name
- the criteria to be applied.void setApplyViewCriteriaName(java.lang.String name, boolean bAppend)
bAppend
is true the passed view criteria will be applied in addition
to the existing ones. If bAppend
is false this method is
identical to setApplyViewCriteriaName(String)
If name
is null there will be no applied view criteria
(identical to setApplyViewCriteriaName(null)
;
bAppend
will be ignored).
name
- the criteria to be appliedbAppend
- pass true
if the view criteria needs to be appended to
the applied list otherwise the list is cleared out.void setApplyViewCriteriaNames(java.lang.String[] names)
names
- the criterias to be applied.ViewCriteria[] getApplyViewCriterias(int criteriaMode)
ViewCriteria.CRITERIA_MODE_CACHE
and
ViewCriteria.CRITERIA_MODE_QUERY
for more information. View criterias
that have both modes turned on are also qualified.criteriaMode
- the mode to match the criteria.java.lang.String[] getApplyViewCriteriaNames()
void setCurrentUnionViewCriteriaName(java.lang.String vcName)
java.lang.String getViewCriteriaClause(boolean forQuery)
forQuery
- true
if the clause is needed for a database
query, false
for in-memory filtering.CriteriaClauses buildViewCriteriaClauses(ViewCriteria vc)
getViewCriteriaClause(boolean)
vc
- the view criteria whose criteria needs to be generatedvoid criteriaChanged(ViewCriteria vc)
vc
- the view criteria that has changedvoid resetCriteria(ViewCriteria vc)
vc
- View Criteria to be reset