SearchTemplate (Oracle Communications Billing and Revenue Management Customer Center SDK Java API Reference)

java.lang.Object
- com.portal.search.SearchTemplate

All Implemented Interfaces:

Serializable, Comparable
```
public class SearchTemplate
extends Object
implements Serializable, Comparable
```
The SearchTemplate class is intended to be a basic data structure for containing template information.

Version:

%version: 18 % %date_modified: Tue May 28 10:23:37 2002 %

Author:

Larry Lynch-Freshner, Monica Gaines

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`caption`
`String[]`	`classes`
`String`	`directClass`
`String`	`directSearch`
`boolean`	`directType`
`String`	`indirectClass`
`String`	`indirectSearch`
`String`	`indirectSpec`
`boolean`	`isGen`
`String`	`localName`
`String`	`mergeSearch`
`String`	`mergeSpec`
`String`	`name`
`static String`	`PREFIX`
`Properties`	`props`
`boolean`	`readFields`
`ResultData[]`	`results`
`String`	`sort`
`int`	`sortIndex`
`String`	`spec`
`String`	`subClass`
`boolean`	`usable`
`boolean`	`used`

Constructor Summary

Constructors
Constructor and Description

SearchTemplate()

Constructors
Constructor and Description
`SearchTemplate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Object otherSearchTemplate)` The method is the implementation for Comparable Interface.
`Hashtable`	`getControlInfo()`
`PModelHandle`	`getDirectArgs()`
`String[]`	`getResultLabels()` Returns the result labels for the given template.
`void`	`setControlInfo(Hashtable ciTbl)`
`void`	`setDirectArgs(PModelHandle dArgs)` Sets the PModelHandle for the search template.

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

Field Detail

PREFIX
```
public static final String PREFIX
```
See Also:

Constant Field Values

name
```
public String name
```

localName
```
public String localName
```

directType
```
public boolean directType
```

spec
```
public String spec
```

directClass
```
public String directClass
```

subClass
```
public String subClass
```

indirectClass
```
public String indirectClass
```

indirectSpec
```
public String indirectSpec
```

caption
```
public String caption
```

props
```
public Properties props
```

isGen
```
public boolean isGen
```

used
```
public boolean used
```

usable
```
public boolean usable
```

results
```
public ResultData[] results
```

sort
```
public String sort
```

sortIndex
```
public int sortIndex
```

classes
```
public String[] classes
```

mergeSpec
```
public String mergeSpec
```

mergeSearch
```
public String mergeSearch
```

readFields
```
public boolean readFields
```

directSearch
```
public String directSearch
```

indirectSearch
```
public String indirectSearch
```

Constructor Detail
- SearchTemplate
```
public SearchTemplate()
```

Method Detail
- setDirectArgs
```
public void setDirectArgs(PModelHandle dArgs)
```
  Sets the PModelHandle for the search template. It is used to build the search panel and to generate the search.
  
  Parameters:
  
  dArgs - the PModelHandle representing the arguments
- getDirectArgs
```
public PModelHandle getDirectArgs()
```
- getControlInfo
```
public Hashtable getControlInfo()
```
- setControlInfo
```
public void setControlInfo(Hashtable ciTbl)
```
- compareTo
```
public int compareTo(Object otherSearchTemplate)
```
  The method is the implementation for Comparable Interface. This directs the sorting mechanism to be done for SearchTemplate objects.
  
  Specified by:
  
  compareTo in interface Comparable
  
  Parameters:
  
  otherSearchTemplate - the SearchTemplate representing the arguments
- getResultLabels
```
public String[] getResultLabels()
```
  Returns the result labels for the given template.

Class SearchTemplate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PREFIX

name

localName

directType

spec

directClass

subClass

indirectClass

indirectSpec

caption

props

isGen

used

usable

results

sort

sortIndex

classes

mergeSpec

mergeSearch

readFields

directSearch

indirectSearch

Constructor Detail

SearchTemplate

Method Detail

setDirectArgs

getDirectArgs

getControlInfo

setControlInfo

compareTo

getResultLabels