BaseController (Oracle WebCenter Sites Java API Reference)

java.lang.Object
- com.fatwire.assetapi.data.BaseController

All Implemented Interfaces:: COM.FutureTense.Interfaces.Controller, COM.FutureTense.Interfaces.WCSController

@Exported
public abstract class BaseController
extends Object
implements COM.FutureTense.Interfaces.WCSController

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BaseController.ModelAndViewImpl

static class BaseController.Watch

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseController.ModelAndViewImpl`
`static class`	`BaseController.Watch`

Field Summary

Fields
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 Summary

Constructors
Constructor and Description

BaseController()

Constructors
Constructor and Description
`BaseController()`

Method Summary

All Methods Instance Methods Concrete Methods
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> List<F>`	`newFragmentList()` Returns an empty list typed for fragments.
`protected <F extends EditableTemplateFragment<F>> List<EditableTemplateFragment<?>>`	`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)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - models
```
protected Map models
```
  - ics
```
protected ICS ics
```
  - queryParams
```
protected Map<String,List<String>> queryParams
```
  - headers
```
protected Map<String,List<String>> headers
```
  - templateParams
```
protected Map<String,String> templateParams
```
  - viewMarkup
```
protected String viewMarkup
```
  - redirectViewPagename
```
protected String redirectViewPagename
```
  - templateMap
```
protected List<Map<String,String>> templateMap
```
  - sessionVariables
```
protected Map<String,String> sessionVariables
```
  - variables
```
protected Map<String,String> variables
```
  - elementCatalogParameters
```
protected Map<String,String> elementCatalogParameters
```
  - children
```
protected List<Class> children
```
  - log
```
protected static org.apache.commons.logging.Log log
```
  - defaultBuildersFactory
```
protected BuildersFactory defaultBuildersFactory
```
- Constructor Detail
  - BaseController
```
public BaseController()
```
- Method Detail
  - getAssetId
```
protected AssetId getAssetId()
```
  - newSearcher
```
protected Searcher newSearcher()
```
    Returns a new Searcher which can be further built upon for creating a search query.
    
    Returns:
    
    a Searcher instance.
  - newTableReader
```
protected oracle.fatwire.api.TableReader newTableReader()
```
    Returns a new TableReader which can be used to query Sites managed tables
    
    Returns:
    
    a TableReader instance.
  - newFilter
```
protected Filter newFilter(String left,
                           BinaryRelationalOperator operator,
                           String right,
                           String... more)
```
    Returns a new 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.
    
    Parameters:
    
    left - left
    
    operator - operator
    
    right - right
    
    more - more
    
    Returns:
    
    a Filter instance. see Filter FilterBuilder Searcher
  - newOrderChain
```
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. 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...)
    
    Parameters:
    
    sortField - sortField
    
    more - more
    
    Returns:
    
    a OrderBuilder.OrderChainBuilder instance. see Orders Order Searcher
  - newOrderChain
```
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. 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.
    
    Parameters:
    
    sortField - sortField
    
    more - more
    
    direction - direction
    
    Returns:
    
    a OrderBuilder.OrderChainBuilder instance. see Orders Order Searcher
  - newTemplateFragment
```
protected TemplateFragment<?> newTemplateFragment()
```
    Returns a new TemplateFragment instance.
    
    Returns:
    
    a Template fragment.
  - newEditableTemplateFragment
```
protected EditableTemplateFragment<?> newEditableTemplateFragment()
```
    Returns a new EditableTemplateFragment instance.
    
    Returns:
    
    an editable Template fragment.
  - newSiteEntryFragment
```
protected SiteEntryFragment<?> newSiteEntryFragment()
```
    Returns a new SiteEntryFragment instance.
    
    Returns:
    
    a SiteEntry fragment.
  - newElementFragment
```
protected ElementFragment<?> newElementFragment()
```
    Returns a new ElementFragment instance.
    
    Returns:
    
    an Element fragment.
  - newFragmentList
```
protected <F extends Fragment> List<F> newFragmentList()
```
    Returns an empty list typed for fragments.
    
    Type Parameters:
    
    F - any subclass of Fragment which can be copied.
    
    Returns:
    
    the empty fragment list.
  - newFragmentList
```
protected <F extends EditableTemplateFragment<F>> List<EditableTemplateFragment<?>> newFragmentList(int initialSize,
                                                                                                    F prototype)
```
    Returns a list of the specified size initially filled with fragments based on a prototype fragment. Note: Currently fragment list initialization based on template is only available to implementations of only.
    
    Type Parameters:
    
    F - any subclass of Fragment which can be copied. any subclass of Fragment which can be copied.
    
    Parameters:
    
    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.
    
    Returns:
    
    list the fragment list containing prototyped fragments.
  - newAssetReader
```
protected AssetReader newAssetReader()
```
  - newRecommendationReader
```
protected RecommendationReader newRecommendationReader()
```
  - newNavigationReader
```
protected NavigationReader newNavigationReader()
```
  - newLinkFactory
```
protected LinkFactory newLinkFactory()
```
  - newAssetLinkInfo
```
protected LinkInfo newAssetLinkInfo()
```
  - newBlobLinkInfo
```
protected BlobLinkInfo newBlobLinkInfo()
```
  - newLegacyAssetLinkInfo
```
protected LegacyLinkInfo newLegacyAssetLinkInfo()
```
  - newLegacyBlobLinkInfo
```
protected LegacyBlobLinkInfo newLegacyBlobLinkInfo()
```
  - setICS
```
public void setICS(ICS ics)
```
    Specified by:
    
    setICS in interface COM.FutureTense.Interfaces.WCSController
  - getDevice
```
public com.fatwire.cs.core.mobility.device.Device getDevice()
```
    Specified by:
    
    getDevice in interface COM.FutureTense.Interfaces.WCSController
  - setDevice
```
public void setDevice(com.fatwire.cs.core.mobility.device.Device device)
```
    Specified by:
    
    setDevice in interface COM.FutureTense.Interfaces.WCSController
  - getModels
```
public Map getModels()
```
    Specified by:
    
    getModels in interface COM.FutureTense.Interfaces.Controller
  - setModels
```
public void setModels(Map models)
```
    Specified by:
    
    setModels in interface COM.FutureTense.Interfaces.WCSController
  - getQueryParams
```
public Map<String,List<String>> getQueryParams()
```
    Specified by:
    
    getQueryParams in interface COM.FutureTense.Interfaces.WCSController
  - getHeaders
```
public Map<String,List<String>> getHeaders()
```
    Specified by:
    
    getHeaders in interface COM.FutureTense.Interfaces.WCSController
  - getTemplateParams
```
public Map<String,String> getTemplateParams()
```
    Specified by:
    
    getTemplateParams in interface COM.FutureTense.Interfaces.WCSController
  - getViewMarkup
```
public String getViewMarkup()
```
    Specified by:
    
    getViewMarkup in interface COM.FutureTense.Interfaces.WCSController
  - getTemplateMap
```
public List<Map<String,String>> getTemplateMap()
```
    Specified by:
    
    getTemplateMap in interface COM.FutureTense.Interfaces.WCSController
  - getSessionVariables
```
public Map<String,String> getSessionVariables()
```
    Specified by:
    
    getSessionVariables in interface COM.FutureTense.Interfaces.WCSController
  - getVariables
```
public Map<String,String> getVariables()
```
    Specified by:
    
    getVariables in interface COM.FutureTense.Interfaces.WCSController
  - getElementCatalogParameters
```
public Map<String,String> getElementCatalogParameters()
```
    Specified by:
    
    getElementCatalogParameters in interface COM.FutureTense.Interfaces.WCSController
  - setTemplateMap
```
public void setTemplateMap(List<Map<String,String>> templateMap)
```
    Specified by:
    
    setTemplateMap in interface COM.FutureTense.Interfaces.WCSController
  - setSessionVariables
```
public void setSessionVariables(Map<String,String> sessionVariables)
```
    Specified by:
    
    setSessionVariables in interface COM.FutureTense.Interfaces.WCSController
  - setVariables
```
public void setVariables(Map<String,String> variables)
```
    Specified by:
    
    setVariables in interface COM.FutureTense.Interfaces.WCSController
  - setElementCatalogParameters
```
public void setElementCatalogParameters(Map<String,String> elementCatalogParameters)
```
    Specified by:
    
    setElementCatalogParameters in interface COM.FutureTense.Interfaces.WCSController
  - setViewMarkup
```
public void setViewMarkup(String view)
```
    Specified by:
    
    setViewMarkup in interface COM.FutureTense.Interfaces.WCSController
  - setRedirectViewPagename
```
public void setRedirectViewPagename(String redirectViewPagename)
```
    Specified by:
    
    setRedirectViewPagename in interface COM.FutureTense.Interfaces.WCSController
  - getRedirectViewPagename
```
public String getRedirectViewPagename()
```
    Specified by:
    
    getRedirectViewPagename in interface COM.FutureTense.Interfaces.WCSController
  - setQueryParams
```
public void setQueryParams(Map<String,List<String>> queryParams)
```
    Specified by:
    
    setQueryParams in interface COM.FutureTense.Interfaces.WCSController
  - setHeaders
```
public void setHeaders(Map<String,List<String>> headers)
```
    Specified by:
    
    setHeaders in interface COM.FutureTense.Interfaces.WCSController
  - setTemplateParams
```
public void setTemplateParams(Map<String,String> templateParams)
```
    Specified by:
    
    setTemplateParams in interface COM.FutureTense.Interfaces.WCSController
  - logDeps
```
protected void logDeps(String... deps)
```
  - logAssetDeps
```
protected void logAssetDeps(AssetId... assetIds)
```
  - handleRequest
```
public COM.FutureTense.Interfaces.DependenciesAwareModelAndView handleRequest()
```
    Specified by:
    
    handleRequest in interface COM.FutureTense.Interfaces.Controller
  - doWork
```
protected void doWork(Map models)
```
  - watch
```
protected com.fatwire.assetapi.data.BaseController.Watches watch(String name)
```
  - watch
```
protected com.fatwire.assetapi.data.BaseController.Watches watch(String name,
                                                                 Map<?,?> object)
```
  - getReaderFactory
```
public BuildersFactory getReaderFactory()
```
  - setReaderFactory
```
public void setReaderFactory(BuildersFactory buildersFactory)
```
  - addSessionVariables
```
public void addSessionVariables(Map<String,String> variables)
```
    append a set of session variables into the ics session scope and the Controller
    
    Parameters:
    
    variables - the name/values of the session variables to append
  - addVariables
```
public void addVariables(Map<String,String> variables)
```
    append a set of variables into the ics scope and the Controller
    
    Parameters:
    
    variables - the name and values of the variables to append
  - addSessionVariable
```
public void addSessionVariable(String name,
                               String value)
```
  - removeSessionVariable
```
public void removeSessionVariable(String name)
```
  - addVariable
```
public void addVariable(String name,
                        String value)
```
  - removeVariable
```
public void removeVariable(String name)
```
  - setCookie
```
public void setCookie(String name,
                      String value,
                      int timeout,
                      String url,
                      String domain,
                      boolean bSecure)
```
  - getCookie
```
public String getCookie(String name)
```
  - lookUp
```
public List<AssetId> lookUp(String assetType,
                            String assetName,
                            String site)
```

Class BaseController

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

models

ics

queryParams

headers

templateParams

viewMarkup

redirectViewPagename

templateMap

sessionVariables

variables

elementCatalogParameters

children

log

defaultBuildersFactory

Constructor Detail

BaseController

Method Detail

getAssetId

newSearcher

newTableReader

newFilter

newOrderChain

newOrderChain

newTemplateFragment

newEditableTemplateFragment

newSiteEntryFragment

newElementFragment

newFragmentList

newFragmentList

newAssetReader

newRecommendationReader

newNavigationReader

newLinkFactory

newAssetLinkInfo

newBlobLinkInfo

newLegacyAssetLinkInfo

newLegacyBlobLinkInfo

setICS

getDevice

setDevice

getModels

setModels

getQueryParams

getHeaders

getTemplateParams

getViewMarkup

getTemplateMap

getSessionVariables

getVariables

getElementCatalogParameters

setTemplateMap

setSessionVariables

setVariables

setElementCatalogParameters

setViewMarkup

setRedirectViewPagename

getRedirectViewPagename

setQueryParams

setHeaders

setTemplateParams

logDeps

logAssetDeps

handleRequest

doWork

watch

watch

getReaderFactory

setReaderFactory

addSessionVariables

addVariables

addSessionVariable

removeSessionVariable

addVariable