BuildersFactory (Oracle WebCenter Sites Java API Reference)

All Known Implementing Classes:

DefaultBuildersFactory
```
@Exported
public interface BuildersFactory
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addSessionVariable(String name, String value)`
`void`	`addVariable(String name, String value)`
`AssetId`	`getAssetId()`
`String`	`getCookie(String name)`
`void`	`logAssetDeps(AssetId... assetIds)`
`void`	`logDeps(String... deps)`
`List<AssetId>`	`lookUp(String assetType, String assetName, String siteName)`
`LinkInfo`	`newAssetLinkInfo()`
`AssetReader`	`newAssetReader()`
`BlobLinkInfo`	`newBlobLinkInfo()`
`EditableTemplateFragment<?>`	`newEditableTemplateFragment()` Returns a new `EditableTemplateFragment` instance.
`ElementFragment<?>`	`newElementFragment()` Returns a new `ElementFragment` instance.
`Filter`	`newFilter(String left, BinaryRelationalOperator operator, String right, String... more)` Returns a new `Filter` which can be used in a search query.
`<F extends Fragment> List<F>`	`newFragmentList()` Returns an empty list typed for fragments.
`<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.
`LegacyLinkInfo`	`newLegacyAssetLinkInfo()`
`LegacyBlobLinkInfo`	`newLegacyBlobLinkInfo()`
`LinkFactory`	`newLinkFactory()`
`NavigationReader`	`newNavigationReader()`
`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.
`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.
`RecommendationReader`	`newRecommendationReader()`
`Searcher`	`newSearcher()` Returns a `Searcher` which can be further built upon for creating a search query.
`SiteEntryFragment<?>`	`newSiteEntryFragment()` Returns a new `SiteEntryFragment` instance.
`oracle.fatwire.api.TableReader`	`newTableReader()` Returns a new `TableReader` which can be used to query Sites managed tables.
`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)`

- Method Detail
  - getAssetId
```
AssetId getAssetId()
```
  - newTableReader
```
oracle.fatwire.api.TableReader newTableReader()
```
    Returns a new TableReader which can be used to query Sites managed tables.
    
    Returns:
    
    A TableReader instance.
  - newSearcher
```
Searcher newSearcher()
```
    Returns a Searcher which can be further built upon for creating a search query.
    
    Returns:
    
    A Searcher instance.
  - newFilter
```
Filter newFilter(String left,
                 BinaryRelationalOperator operator,
                 String right,
                 String... more)
```
    Returns a new Filter which can be used in a search query. This filter may be used to build more complex filters (see composite Filter instances). Once ready, the filter maybe used in a query by invoking the Searcher filter(Filter) method.
    
    Parameters:
    
    left - left
    
    operator - operator
    
    more - more
    
    right - right
    
    Returns:
    
    A Filter instance. see Filter FilterBuilder Searcher
  - newOrderChain
```
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 Also:
    
    Order Searcher
  - newOrderChain
```
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
```
TemplateFragment<?> newTemplateFragment()
```
    Returns a new TemplateFragment instance.
    
    Returns:
    
    A Template fragment.
  - newEditableTemplateFragment
```
EditableTemplateFragment<?> newEditableTemplateFragment()
```
    Returns a new EditableTemplateFragment instance.
    
    Returns:
    
    An editable Template fragment.
  - newSiteEntryFragment
```
SiteEntryFragment<?> newSiteEntryFragment()
```
    Returns a new SiteEntryFragment instance.
    
    Returns:
    
    A SiteEntry fragment.
  - newElementFragment
```
ElementFragment<?> newElementFragment()
```
    Returns a new ElementFragment instance.
    
    Returns:
    
    An Element fragment.
  - newFragmentList
```
<F extends Fragment> List<F> newFragmentList()
```
    Returns an empty list typed for fragments.
    
    Parameters:
    
    Any - subclass of Fragment which can be copied.
    
    Returns:
    
    The empty fragment list.
  - newFragmentList
```
<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 - 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:
    
    The fragment list containing prototyped fragments.
  - newAssetReader
```
AssetReader newAssetReader()
```
  - newRecommendationReader
```
RecommendationReader newRecommendationReader()
```
  - newNavigationReader
```
NavigationReader newNavigationReader()
```
  - newLinkFactory
```
LinkFactory newLinkFactory()
```
  - newAssetLinkInfo
```
LinkInfo newAssetLinkInfo()
```
  - newBlobLinkInfo
```
BlobLinkInfo newBlobLinkInfo()
```
  - newLegacyAssetLinkInfo
```
LegacyLinkInfo newLegacyAssetLinkInfo()
```
  - newLegacyBlobLinkInfo
```
LegacyBlobLinkInfo newLegacyBlobLinkInfo()
```
  - logDeps
```
void logDeps(String... deps)
```
  - logAssetDeps
```
void logAssetDeps(AssetId... assetIds)
```
  - addSessionVariable
```
void addSessionVariable(String name,
                        String value)
```
  - removeSessionVariable
```
void removeSessionVariable(String name)
```
  - addVariable
```
void addVariable(String name,
                 String value)
```
  - removeVariable
```
void removeVariable(String name)
```
  - setCookie
```
void setCookie(String name,
               String value,
               int timeout,
               String url,
               String domain,
               boolean bSecure)
```
  - getCookie
```
String getCookie(String name)
```
  - lookUp
```
List<AssetId> lookUp(String assetType,
                     String assetName,
                     String siteName)
```

Interface BuildersFactory

Method Summary

Method Detail

getAssetId

newTableReader

newSearcher

newFilter

newOrderChain

newOrderChain

newTemplateFragment

newEditableTemplateFragment

newSiteEntryFragment

newElementFragment

newFragmentList

newFragmentList

newAssetReader

newRecommendationReader

newNavigationReader

newLinkFactory

newAssetLinkInfo

newBlobLinkInfo

newLegacyAssetLinkInfo

newLegacyBlobLinkInfo

logDeps

logAssetDeps

addSessionVariable

removeSessionVariable

addVariable

removeVariable

setCookie

getCookie

lookUp