@Exported public abstract class BaseController extends Object implements COM.FutureTense.Interfaces.WCSController
Modifier and Type | Class and Description |
---|---|
static class |
BaseController.ModelAndViewImpl |
static class |
BaseController.Watch |
Modifier and Type | Field and Description |
---|---|
protected List<Class> |
children |
protected BuildersFactory |
defaultBuildersFactory |
protected Map<String,String> |
elementCatalogParameters |
protected Map<String,List<String>> |
headers |
protected ICS |
ics |
protected static org.apache.commons.logging.Log |
log |
protected Map |
models |
protected Map<String,List<String>> |
queryParams |
protected String |
redirectViewPagename |
protected Map<String,String> |
sessionVariables |
protected List<Map<String,String>> |
templateMap |
protected Map<String,String> |
templateParams |
protected Map<String,String> |
variables |
protected String |
viewMarkup |
Constructor and Description |
---|
BaseController() |
Modifier and Type | Method and Description |
---|---|
void |
addSessionVariable(String name,
String value) |
void |
addSessionVariables(Map<String,String> variables)
append a set of session variables into the ics session scope and the Controller
|
void |
addVariable(String name,
String value) |
void |
addVariables(Map<String,String> variables)
append a set of variables into the ics scope and the Controller
|
protected void |
doWork(Map models) |
protected AssetId |
getAssetId() |
String |
getCookie(String name) |
com.fatwire.cs.core.mobility.device.Device |
getDevice() |
Map<String,String> |
getElementCatalogParameters() |
Map<String,List<String>> |
getHeaders() |
Map |
getModels() |
Map<String,List<String>> |
getQueryParams() |
BuildersFactory |
getReaderFactory() |
String |
getRedirectViewPagename() |
Map<String,String> |
getSessionVariables() |
List<Map<String,String>> |
getTemplateMap() |
Map<String,String> |
getTemplateParams() |
Map<String,String> |
getVariables() |
String |
getViewMarkup() |
COM.FutureTense.Interfaces.DependenciesAwareModelAndView |
handleRequest() |
protected void |
logAssetDeps(AssetId... assetIds) |
protected void |
logDeps(String... deps) |
List<AssetId> |
lookUp(String assetType,
String assetName,
String site) |
protected LinkInfo |
newAssetLinkInfo() |
protected AssetReader |
newAssetReader() |
protected BlobLinkInfo |
newBlobLinkInfo() |
protected EditableTemplateFragment<?> |
newEditableTemplateFragment()
Returns a new
EditableTemplateFragment instance. |
protected ElementFragment<?> |
newElementFragment()
Returns a new
ElementFragment instance. |
protected Filter |
newFilter(String left,
BinaryRelationalOperator operator,
String right,
String... more)
Returns a new
Filter which can used in a search query. |
protected <F extends Fragment> |
newFragmentList()
Returns an empty list typed for fragments.
|
protected <F extends EditableTemplateFragment<F>> |
newFragmentList(int initialSize,
F prototype)
Returns a list of the specified size initially filled with fragments based on a prototype fragment.
|
protected LegacyLinkInfo |
newLegacyAssetLinkInfo() |
protected LegacyBlobLinkInfo |
newLegacyBlobLinkInfo() |
protected LinkFactory |
newLinkFactory() |
protected NavigationReader |
newNavigationReader() |
protected OrderBuilder.OrderChainBuilder<?> |
newOrderChain(SortDirection direction,
String sortField,
String... more)
Returns a new
OrderBuilder.OrderChainBuilder instance which can be further built upon for creating a list orders for using in a search query. |
protected OrderBuilder.OrderChainBuilder<?> |
newOrderChain(String sortField,
String... more)
Returns a new
OrderBuilder.OrderChainBuilder instance which can be further built upon for creating a list orders for using in a search query. |
protected RecommendationReader |
newRecommendationReader() |
protected Searcher |
newSearcher()
Returns a new
Searcher which can be further built upon for creating a search query. |
protected SiteEntryFragment<?> |
newSiteEntryFragment()
Returns a new
SiteEntryFragment instance. |
protected oracle.fatwire.api.TableReader |
newTableReader()
Returns a new
TableReader which can be used to query Sites managed tables |
protected TemplateFragment<?> |
newTemplateFragment()
Returns a new
TemplateFragment instance. |
void |
removeSessionVariable(String name) |
void |
removeVariable(String name) |
void |
setCookie(String name,
String value,
int timeout,
String url,
String domain,
boolean bSecure) |
void |
setDevice(com.fatwire.cs.core.mobility.device.Device device) |
void |
setElementCatalogParameters(Map<String,String> elementCatalogParameters) |
void |
setHeaders(Map<String,List<String>> headers) |
void |
setICS(ICS ics) |
void |
setModels(Map models) |
void |
setQueryParams(Map<String,List<String>> queryParams) |
void |
setReaderFactory(BuildersFactory buildersFactory) |
void |
setRedirectViewPagename(String redirectViewPagename) |
void |
setSessionVariables(Map<String,String> sessionVariables) |
void |
setTemplateMap(List<Map<String,String>> templateMap) |
void |
setTemplateParams(Map<String,String> templateParams) |
void |
setVariables(Map<String,String> variables) |
void |
setViewMarkup(String view) |
protected com.fatwire.assetapi.data.BaseController.Watches |
watch(String name) |
protected com.fatwire.assetapi.data.BaseController.Watches |
watch(String name,
Map<?,?> object) |
protected Map models
protected ICS ics
protected String viewMarkup
protected String redirectViewPagename
protected static org.apache.commons.logging.Log log
protected BuildersFactory defaultBuildersFactory
protected AssetId getAssetId()
protected Searcher newSearcher()
Searcher
which can be further built upon for creating a search query.Searcher
instance.protected oracle.fatwire.api.TableReader newTableReader()
TableReader
which can be used to query Sites managed tablesTableReader
instance.protected Filter newFilter(String left, BinaryRelationalOperator operator, String right, String... more)
Filter
which can used in a search query.
This filter may be used to build more complex filters (see composite link Filter instances).
Once ready, the filter maybe used in a query by invoking the Searcher.filter(Filter)
method.left
- leftoperator
- operatorright
- rightmore
- moreFilter
instance.
see
Filter
FilterBuilder
Searcherprotected OrderBuilder.OrderChainBuilder<?> newOrderChain(String sortField, String... more)
OrderBuilder.OrderChainBuilder
instance which can be further built upon for creating a list orders for using in a search query.
The Orders
instance is obtained by invoking the OrderBuilder.OrderChainBuilder.build()
method.
This Orders instance can then be used in a query by invoking the Searcher.orderBy(Orders)
method.
This method is equivalent to invoking newOrderChain(SortDirection.ASCENDING, String, String...)
sortField
- sortFieldmore
- moreOrderBuilder.OrderChainBuilder
instance.
see
Orders
Order
Searcherprotected OrderBuilder.OrderChainBuilder<?> newOrderChain(SortDirection direction, String sortField, String... more)
OrderBuilder.OrderChainBuilder
instance which can be further built upon for creating a list orders for using in a search query.
The Orders
instance is obtained by invoking the OrderBuilder.OrderChainBuilder.build()
method.
This Orders instance can then be used in a query by invoking the Searcher.orderBy(Orders)
method.sortField
- sortFieldmore
- moredirection
- directionOrderBuilder.OrderChainBuilder
instance.
see
Orders
Order
Searcherprotected TemplateFragment<?> newTemplateFragment()
TemplateFragment
instance.protected EditableTemplateFragment<?> newEditableTemplateFragment()
EditableTemplateFragment
instance.protected SiteEntryFragment<?> newSiteEntryFragment()
SiteEntryFragment
instance.protected ElementFragment<?> newElementFragment()
ElementFragment
instance.protected <F extends Fragment> List<F> newFragmentList()
F
- any subclass of Fragment which can be copied.protected <F extends EditableTemplateFragment<F>> List<EditableTemplateFragment<?>> newFragmentList(int initialSize, F prototype)
F
- any subclass of Fragment which can be copied.
any subclass of Fragment which can be copied.initialSize
- initial size of the list
the initial size of the list.
the template based on which the fragments are created and populated into the list.prototype
- list containing prototyped fragments.protected AssetReader newAssetReader()
protected RecommendationReader newRecommendationReader()
protected NavigationReader newNavigationReader()
protected LinkFactory newLinkFactory()
protected LinkInfo newAssetLinkInfo()
protected BlobLinkInfo newBlobLinkInfo()
protected LegacyLinkInfo newLegacyAssetLinkInfo()
protected LegacyBlobLinkInfo newLegacyBlobLinkInfo()
public void setICS(ICS ics)
setICS
in interface COM.FutureTense.Interfaces.WCSController
public com.fatwire.cs.core.mobility.device.Device getDevice()
getDevice
in interface COM.FutureTense.Interfaces.WCSController
public void setDevice(com.fatwire.cs.core.mobility.device.Device device)
setDevice
in interface COM.FutureTense.Interfaces.WCSController
public Map getModels()
getModels
in interface COM.FutureTense.Interfaces.Controller
public void setModels(Map models)
setModels
in interface COM.FutureTense.Interfaces.WCSController
public Map<String,List<String>> getQueryParams()
getQueryParams
in interface COM.FutureTense.Interfaces.WCSController
public Map<String,List<String>> getHeaders()
getHeaders
in interface COM.FutureTense.Interfaces.WCSController
public Map<String,String> getTemplateParams()
getTemplateParams
in interface COM.FutureTense.Interfaces.WCSController
public String getViewMarkup()
getViewMarkup
in interface COM.FutureTense.Interfaces.WCSController
public List<Map<String,String>> getTemplateMap()
getTemplateMap
in interface COM.FutureTense.Interfaces.WCSController
public Map<String,String> getSessionVariables()
getSessionVariables
in interface COM.FutureTense.Interfaces.WCSController
public Map<String,String> getVariables()
getVariables
in interface COM.FutureTense.Interfaces.WCSController
public Map<String,String> getElementCatalogParameters()
getElementCatalogParameters
in interface COM.FutureTense.Interfaces.WCSController
public void setTemplateMap(List<Map<String,String>> templateMap)
setTemplateMap
in interface COM.FutureTense.Interfaces.WCSController
public void setSessionVariables(Map<String,String> sessionVariables)
setSessionVariables
in interface COM.FutureTense.Interfaces.WCSController
public void setVariables(Map<String,String> variables)
setVariables
in interface COM.FutureTense.Interfaces.WCSController
public void setElementCatalogParameters(Map<String,String> elementCatalogParameters)
setElementCatalogParameters
in interface COM.FutureTense.Interfaces.WCSController
public void setViewMarkup(String view)
setViewMarkup
in interface COM.FutureTense.Interfaces.WCSController
public void setRedirectViewPagename(String redirectViewPagename)
setRedirectViewPagename
in interface COM.FutureTense.Interfaces.WCSController
public String getRedirectViewPagename()
getRedirectViewPagename
in interface COM.FutureTense.Interfaces.WCSController
public void setQueryParams(Map<String,List<String>> queryParams)
setQueryParams
in interface COM.FutureTense.Interfaces.WCSController
public void setHeaders(Map<String,List<String>> headers)
setHeaders
in interface COM.FutureTense.Interfaces.WCSController
public void setTemplateParams(Map<String,String> templateParams)
setTemplateParams
in interface COM.FutureTense.Interfaces.WCSController
protected void logDeps(String... deps)
protected void logAssetDeps(AssetId... assetIds)
public COM.FutureTense.Interfaces.DependenciesAwareModelAndView handleRequest()
handleRequest
in interface COM.FutureTense.Interfaces.Controller
protected void doWork(Map models)
protected com.fatwire.assetapi.data.BaseController.Watches watch(String name)
protected com.fatwire.assetapi.data.BaseController.Watches watch(String name, Map<?,?> object)
public BuildersFactory getReaderFactory()
public void setReaderFactory(BuildersFactory buildersFactory)
public void addSessionVariables(Map<String,String> variables)
variables
- the name/values of the session variables to appendpublic void addVariables(Map<String,String> variables)
variables
- the name and values of the variables to appendpublic void removeSessionVariable(String name)
public void removeVariable(String name)
public void setCookie(String name, String value, int timeout, String url, String domain, boolean bSecure)