SearchObject (java-api 21.0.12 API)

java.lang.Object
- com.uc4.communication.requests.XMLRequest
- - com.uc4.communication.requests.SearchObject

public class SearchObject
extends XMLRequest

Finds UC4 Objects.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SearchObject.VariableDataType
Type of a Variable.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchObject.VariableDataType` Type of a Variable.

Constructor Summary

Constructors
Constructor and Description

SearchObject()
Constructs a Search.

Constructors
Constructor and Description
`SearchObject()` Constructs a `Search`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)` Creates the XML Document for the request.
`void`	`disableTextSearch()` Disable text search.
`DateTime`	`getFromDate()` Returns the begin of the date range.
`java.lang.String`	`getName()` Returns the object name filter.
`java.lang.String`	`getSearchLocation()` Returns the folder path which used in the search.
`protected java.lang.String`	`getSrc()` Returns the request source.
`DateTime`	`getToDate()` Returns the end of the date range.
`protected void`	`handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)`
`protected boolean`	`ignoreMessageBox()`
`protected boolean`	`isAllowedInClientZero()` This method is used internally.
`boolean`	`isDateSelectionCreated()` Returns `true` if the creation date of objects is used in the selection for this search.
`boolean`	`isDateSelectionModified()` Returns `true` if the modification timestamp of objects is used in the selection for this search.
`boolean`	`isDateSelectionUsed()` Returns `true` if the last used timestamp of objects is used in the selection for this search.
`boolean`	`isIncludeLinks()` Returns `true` if links to objects are included in the result.
`boolean`	`isIncludeSubfolder()` Returns `true` if subfolder are included.
`boolean`	`isNoDateSelection()` Returns `true` if the date selection is disabled.
`boolean`	`isSearchUseOfObjects()` Returns `true` if the use of objects is selected.
`boolean`	`isTypeCALE()` Returns whether the object type CALE is enabled for the search or not.
`boolean`	`isTypeCALL()` Returns whether the object type CALL is enabled for the search or not.
`boolean`	`isTypeCITC()` Returns whether the object type CITC is enabled for the search or not.
`boolean`	`isTypeCLNT()` Returns whether the object type CLNT is enabled for the search or not.
`boolean`	`isTypeCODE()` Returns whether the object type CODE is enabled for the search or not.
`boolean`	`isTypeCONN()` Returns whether the object type CONN is enabled for the search or not.
`boolean`	`isTypeCPIT()` Returns whether the object type CPIT is enabled for the search or not.
`boolean`	`isTypeDASH()` Returns whether the object type DASH is enabled for the search or not.
`boolean`	`isTypeDOCU()` Returns whether the object type DOCU is enabled for the search or not.
`boolean`	`isTypeEVNT()` Returns whether the object type EVNT is enabled for the search or not.
`boolean`	`isTypeFILTER()` Returns whether the object type FILTER is enabled for the search or not.
`boolean`	`isTypeFOLD()` Returns whether the object type FOLD is enabled for the search or not.
`boolean`	`isTypeHOST()` Returns whether the object type HOST is enabled for the search or not.
`boolean`	`isTypeHOSTG()` Returns whether the object type HOSTG is enabled for the search or not.
`boolean`	`isTypeHSTA()` Returns whether the object type HSTA is enabled for the search or not.
`boolean`	`isTypeJOBF()` Returns whether the object type JOBF is enabled for the search or not.
`boolean`	`isTypeJOBG()` Returns whether the object type JOBG is enabled for the search or not.
`boolean`	`isTypeJOBI()` Returns whether the object type JOBI is enabled for the search or not.
`boolean`	`isTypeJOBP()` Returns whether the object type JOBP is enabled for the search or not.
`boolean`	`isTypeJOBQ()` Returns whether the object type JOBQ is enabled for the search or not.
`boolean`	`isTypeJOBS()` Returns whether the object type JOBS is enabled for the search or not.
`boolean`	`isTypeJSCH()` Returns whether the object type JSCH is enabled for the search or not.
`boolean`	`isTypeLOGIN()` Returns whether the object type LOGIN is enabled for the search or not.
`boolean`	`isTypePERIOD()` Returns whether the object type STORE is enabled for the search or not.
`boolean`	`isTypePRPT()` Returns whether the object type PRPT is enabled for the search or not.
`boolean`	`isTypeQUEUE()` Returns whether the object type QUEUE is enabled for the search or not.
`boolean`	`isTypeSCRI()` Returns whether the object type SCRI is enabled for the search or not.
`boolean`	`isTypeSERV()` Returns whether the object type SERV is enabled for the search or not.
`boolean`	`isTypeSLO()` Returns whether the object type SLO is enabled for the search or not.
`boolean`	`isTypeSTORE()` Returns whether the object type STORE is enabled for the search or not.
`boolean`	`isTypeSYNC()` Returns whether the object type SYNC is enabled for the search or not.
`boolean`	`isTypeTZ()` Returns whether the object type TZ is enabled for the search or not.
`boolean`	`isTypeUSER()` Returns whether the object type USER is enabled for the search or not.
`boolean`	`isTypeUSRG()` Returns whether the object type USER is enabled for the search or not.
`boolean`	`isTypeVARA()` Returns whether the object type VARA is enabled for the search or not.
`boolean`	`isTypeXSL()` Returns whether the object type XSL is enabled for the search or not.
`java.util.Iterator<SearchResultItem>`	`resultIterator()` Returns an iterator over `SearchResultItem`.
`void`	`searchCalendarKeyword(java.lang.String keywordPattern)` Sets a filter to return only CALE objects which contain the specified `keywordPattern` The default value is *.
`void`	`searchInRAValues(java.lang.String pattern)` Search for RA values.
`void`	`selectAllObjectTypes()` Select all object types.
`void`	`setDateSelectionCreated(DateTime from, DateTime to)` Select objects which are created within the specified date range.
`void`	`setDateSelectionModified(DateTime from, DateTime to)` Select objects which are modified within the specified date range.
`void`	`setDateSelectionUsed(DateTime from, DateTime to)` Select objects which are used within the specified date range.
`void`	`setIncludeLinks(boolean includeLinks)` If the parameter `includeLinks` is set to `true` links to objects are included in the result.
`void`	`setIncludeUseInScripts(boolean scripts)` Enables or disables the content of Scripts in the search.
`void`	`setName(java.lang.String name)` Sets the object name filter.
`void`	`setNameAndTitle(java.lang.String name)` Sets the search pattern for the object name and/or the object title.
`void`	`setNoDateSelection()` Disables date selection.
`void`	`setSearchInVariable(java.lang.String pattern, boolean key, boolean value, boolean allValueColumns, SearchObject.VariableDataType dataType)` Searches in UC4 Variable Objects.
`void`	`setSearchLocation(java.lang.String path, boolean includeSubfolder)` Sets the folder path.
`void`	`setSearchUseOfObjects(boolean searchUseOfObjects)` Enables or disables the search for use of objects.
`void`	`setTextSearch(java.lang.String pattern, boolean process, boolean documentation, boolean objectTitle, boolean archiveKeys)` Search for texts.
`void`	`setTypeCALE(boolean typeCALE)` Enables or disables the object type CALE.
`void`	`setTypeCALL(boolean typeCALL)` Enables or disables the object type CALL.
`void`	`setTypeCITC(boolean typeCITC)` Enables or disables the object type CITC.
`void`	`setTypeCLNT(boolean typeCLNT)` Enables or disables the object type CLNT.
`void`	`setTypeCODE(boolean typeCODE)` Enables or disables the object type CODE.
`void`	`setTypeCONN(boolean typeCONN)` Enables or disables the object type CONN.
`void`	`setTypeCPIT(boolean typeCPIT)` Enables or disables the object type CPIT.
`void`	`setTypeDASH(boolean typeDASH)` Enables or disables the object type DASH.
`void`	`setTypeDOCU(boolean typeDOCU)` Enables or disables the object type DOCU.
`void`	`setTypeEVNT(boolean typeEVNT)` Enables or disables the object type EVNT.
`void`	`setTypeExecuteable()` Selects all executable object types.
`void`	`setTypeFILTER(boolean typeFILTER)` Enables or disables the object type FILTER.
`void`	`setTypeFOLD(boolean typeFOLD)` Enables or disables the object type FOLD.
`void`	`setTypeHOST(boolean typeHOST)` Enables or disables the object type HOST.
`void`	`setTypeHOSTG(boolean typeHOSTG)` Enables or disables the object type HOSTG.
`void`	`setTypeHSTA(boolean typeHSTA)` Enables or disables the object type HSTA.
`void`	`setTypeJOBF(boolean typeJOBF)` Enables or disables the object type JOBF.
`void`	`setTypeJOBG(boolean typeJOBG)` Enables or disables the object type JOBG.
`void`	`setTypeJOBI(boolean typeJOBI)` Enables or disables the object type JOBI.
`void`	`setTypeJOBP(boolean typeJOBP)` Enables or disables the object type JOBP.
`void`	`setTypeJOBQ(boolean typeJOBQ)` Enables or disables the object type JOBQ.
`void`	`setTypeJOBS(boolean typeJOBS)` Enables or disables the object type JOBS.
`void`	`setTypeJSCH(boolean typeJSCH)` Enables or disables the object type JSCH.
`void`	`setTypeLOGIN(boolean typeLOGIN)` Enables or disables the object type LOGIN.
`void`	`setTypePERIOD(boolean typePERIOD)` Enables or disables the object type PERIOD.
`void`	`setTypePRPT(boolean typePRPT)` Enables or disables the object type PRPT.
`void`	`setTypeQUEUE(boolean typeQUEUE)` Enables or disables the object type QUEUE.
`void`	`setTypeSCRI(boolean typeSCRI)` Enables or disables the object type SCRI.
`void`	`setTypeSERV(boolean typeSERV)` Enables or disables the object type SERV.
`void`	`setTypeSLO(boolean typeSLO)` Enables or disables the object type SLO.
`void`	`setTypeSTORE(boolean typeSTORE)` Enables or disables the object type STORE.
`void`	`setTypeSYNC(boolean typeSYNC)` Enables or disables the object type SYNC.
`void`	`setTypeTZ(boolean typeTZ)` Enables or disables the object type TZ.
`void`	`setTypeUSER(boolean typeUSER)` Enables or disables the object type USER.
`void`	`setTypeUSRG(boolean typeUSRG)` Enables or disables the object type USERG.
`void`	`setTypeVARA(boolean typeVARA)` Enables or disables the object type VARA.
`void`	`setTypeXSL(boolean typeXSL)` Enables or disables the object type XSL.
`int`	`size()` Returns the number of objects in the search result.
`void`	`unselectAllObjectTypes()` Unselect all object types.

Methods inherited from class com.uc4.communication.requests.XMLRequest
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send, setMessageBox, showQuarantineNotification

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

- Constructor Detail
  - SearchObject
```
public SearchObject()
```
    Constructs a Search. The default search path is / and the search definition is set to * (all Objects). Version control is not include and no object type is selected.
- Method Detail
  - getSrc
```
protected java.lang.String getSrc()
```
    Description copied from class: XMLRequest
    
    Returns the request source. This method is used internally.
    
    Specified by:
    
    getSrc in class XMLRequest
    
    Returns:
    
    Source
  - createRequest
```
protected void createRequest(com.uc4.util.XMLDocument doc,
                             org.w3c.dom.Element request,
                             ConnectionAttributes sessionInfo)
```
    Description copied from class: XMLRequest
    
    Creates the XML Document for the request. This method is used internally.
    
    Specified by:
    
    createRequest in class XMLRequest
    
    Parameters:
    
    doc - Document, used to create new Elements
    
    request - Request Element - classes append information to this request element
    
    sessionInfo - Information about the session
  - handleContent
```
protected void handleContent(com.uc4.util.XMLDocument doc,
                             ConnectionAttributes session)
```
    Overrides:
    
    handleContent in class XMLRequest
  - ignoreMessageBox
```
protected boolean ignoreMessageBox()
```
    Overrides:
    
    ignoreMessageBox in class XMLRequest
  - setTypeExecuteable
```
public void setTypeExecuteable()
```
    Selects all executable object types.
  - resultIterator
```
public java.util.Iterator<SearchResultItem> resultIterator()
```
    Returns an iterator over SearchResultItem.
    
    Returns:
    
    iterator over SearchResultItem or null if this request does not contain a search result
  - isSearchUseOfObjects
```
public boolean isSearchUseOfObjects()
```
    Returns true if the use of objects is selected.
    
    Returns:
    
    Boolean containing true if the use of objects is selected
  - setSearchUseOfObjects
```
public void setSearchUseOfObjects(boolean searchUseOfObjects)
```
    Enables or disables the search for use of objects.
    
    Parameters:
    
    searchUseOfObjects - Boolean containing true if the use of objects is selected
  - isIncludeLinks
```
public boolean isIncludeLinks()
```
    Returns true if links to objects are included in the result.
    
    Returns:
    
    Include links to objects
  - setIncludeLinks
```
public void setIncludeLinks(boolean includeLinks)
```
    If the parameter includeLinks is set to true links to objects are included in the result.
    
    Parameters:
    
    includeLinks - true to include links in the search result
  - setIncludeUseInScripts
```
public void setIncludeUseInScripts(boolean scripts)
```
    Enables or disables the content of Scripts in the search.
    
    Parameters:
    
    scripts - Boolean containing true if Scripts are included
  - getSearchLocation
```
public java.lang.String getSearchLocation()
```
    Returns the folder path which used in the search.
    
    Returns:
    
    path
  - setSearchLocation
```
public void setSearchLocation(java.lang.String path,
                              boolean includeSubfolder)
```
    Sets the folder path. Only UC4 Objects in the specified folder or subfolders are found.
    
    Parameters:
    
    path - Path
    
    includeSubfolder - Include subfolder
  - isIncludeSubfolder
```
public boolean isIncludeSubfolder()
```
    Returns true if subfolder are included.
    
    Returns:
    
    Boolean containing true if subfolders are included
  - getName
```
public java.lang.String getName()
```
    Returns the object name filter.
    
    Returns:
    
    Pattern containing the object name
  - setNameAndTitle
```
public void setNameAndTitle(java.lang.String name)
```
    Sets the search pattern for the object name and/or the object title. By default this method adds the wildcard character '*' as prefix to the given search pattern.
    
    Parameters:
    
    name - Pattern containing the object name or title
  - setName
```
public void setName(java.lang.String name)
```
    Sets the object name filter.
    
    Parameters:
    
    name - Pattern containing the object name
  - isTypeCALE
```
public boolean isTypeCALE()
```
    Returns whether the object type CALE is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type CALE is enabled
  - setTypeCALE
```
public void setTypeCALE(boolean typeCALE)
```
    Enables or disables the object type CALE.
    
    Parameters:
    
    typeCALE - Boolean which is set to true if objects of type CALE should be returned.
  - isTypeCITC
```
public boolean isTypeCITC()
```
    Returns whether the object type CITC is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type CITC is enabled
  - setTypeCITC
```
public void setTypeCITC(boolean typeCITC)
```
    Enables or disables the object type CITC.
    
    Parameters:
    
    typeCITC - Boolean which is set to true if objects of type CITC should be returned.
  - isTypeCONN
```
public boolean isTypeCONN()
```
    Returns whether the object type CONN is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type CONN is enabled
  - setTypeCONN
```
public void setTypeCONN(boolean typeCONN)
```
    Enables or disables the object type CONN.
    
    Parameters:
    
    typeCONN - Boolean which is set to true if objects of type CONN should be returned.
  - isTypeFILTER
```
public boolean isTypeFILTER()
```
    Returns whether the object type FILTER is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type FILTER is enabled
  - isTypeQUEUE
```
public boolean isTypeQUEUE()
```
    Returns whether the object type QUEUE is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type QUEUE is enabled
  - setTypeQUEUE
```
public void setTypeQUEUE(boolean typeQUEUE)
```
    Enables or disables the object type QUEUE.
    
    Parameters:
    
    typeQUEUE - Boolean which is set to true if objects of type QUEUE should be returned.
  - setTypeFILTER
```
public void setTypeFILTER(boolean typeFILTER)
```
    Enables or disables the object type FILTER.
    
    Parameters:
    
    typeFILTER - Boolean which is set to true if objects of type FILTER should be returned.
  - isTypeHSTA
```
public boolean isTypeHSTA()
```
    Returns whether the object type HSTA is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type HSTA is enabled
  - setTypeHSTA
```
public void setTypeHSTA(boolean typeHSTA)
```
    Enables or disables the object type HSTA.
    
    Parameters:
    
    typeHSTA - Boolean which is set to true if objects of type HSTA should be returned.
  - isTypeXSL
```
public boolean isTypeXSL()
```
    Returns whether the object type XSL is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type XSL is enabled
  - setTypeXSL
```
public void setTypeXSL(boolean typeXSL)
```
    Enables or disables the object type XSL.
    
    Parameters:
    
    typeXSL - Boolean which is set to true if objects of type XSL should be returned.
  - isTypeCALL
```
public boolean isTypeCALL()
```
    Returns whether the object type CALL is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type CALL is enabled
  - setTypeCALL
```
public void setTypeCALL(boolean typeCALL)
```
    Enables or disables the object type CALL.
    
    Parameters:
    
    typeCALL - Boolean which is set to true if objects of type CALL should be returned.
  - isTypeCLNT
```
public boolean isTypeCLNT()
```
    Returns whether the object type CLNT is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type CLNT is enabled
  - setTypeCLNT
```
public void setTypeCLNT(boolean typeCLNT)
```
    Enables or disables the object type CLNT.
    
    Parameters:
    
    typeCLNT - Boolean which is set to true if objects of type CLNT should be returned.
  - isTypeCODE
```
public boolean isTypeCODE()
```
    Returns whether the object type CODE is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type CODE is enabled
  - setTypeCODE
```
public void setTypeCODE(boolean typeCODE)
```
    Enables or disables the object type CODE.
    
    Parameters:
    
    typeCODE - Boolean which is set to true if objects of type CODE should be returned.
  - isTypeCPIT
```
public boolean isTypeCPIT()
```
    Returns whether the object type CPIT is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type CPIT is enabled
  - setTypeCPIT
```
public void setTypeCPIT(boolean typeCPIT)
```
    Enables or disables the object type CPIT.
    
    Parameters:
    
    typeCPIT - Boolean which is set to true if objects of type CPIT should be returned.
  - isTypeDOCU
```
public boolean isTypeDOCU()
```
    Returns whether the object type DOCU is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type DOCU is enabled
  - setTypeDOCU
```
public void setTypeDOCU(boolean typeDOCU)
```
    Enables or disables the object type DOCU.
    
    Parameters:
    
    typeDOCU - Boolean which is set to true if objects of type DOCU should be returned.
  - isTypeEVNT
```
public boolean isTypeEVNT()
```
    Returns whether the object type EVNT is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type EVNT is enabled
  - setTypeEVNT
```
public void setTypeEVNT(boolean typeEVNT)
```
    Enables or disables the object type EVNT.
    
    Parameters:
    
    typeEVNT - Boolean which is set to true if objects of type EVNT should be returned.
  - isTypeFOLD
```
public boolean isTypeFOLD()
```
    Returns whether the object type FOLD is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type FOLD is enabled
  - setTypeFOLD
```
public void setTypeFOLD(boolean typeFOLD)
```
    Enables or disables the object type FOLD.
    
    Parameters:
    
    typeFOLD - Boolean which is set to true if objects of type FOLD should be returned.
  - isTypeHOST
```
public boolean isTypeHOST()
```
    Returns whether the object type HOST is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type HOST is enabled
  - setTypeHOST
```
public void setTypeHOST(boolean typeHOST)
```
    Enables or disables the object type HOST.
    
    Parameters:
    
    typeHOST - Boolean which is set to true if objects of type HOST should be returned.
  - isTypeJOBF
```
public boolean isTypeJOBF()
```
    Returns whether the object type JOBF is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type JOBF is enabled
  - setTypeJOBF
```
public void setTypeJOBF(boolean typeJOBF)
```
    Enables or disables the object type JOBF.
    
    Parameters:
    
    typeJOBF - Boolean which is set to true if objects of type JOBF should be returned.
  - isTypeJOBG
```
public boolean isTypeJOBG()
```
    Returns whether the object type JOBG is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type JOBG is enabled
  - setTypeJOBG
```
public void setTypeJOBG(boolean typeJOBG)
```
    Enables or disables the object type JOBG.
    
    Parameters:
    
    typeJOBG - Boolean which is set to true if objects of type JOBG should be returned.
  - isTypeJOBI
```
public boolean isTypeJOBI()
```
    Returns whether the object type JOBI is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type JOBI is enabled
  - isTypeHOSTG
```
public boolean isTypeHOSTG()
```
    Returns whether the object type HOSTG is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type HOSTG is enabled
  - setTypeHOSTG
```
public void setTypeHOSTG(boolean typeHOSTG)
```
    Enables or disables the object type HOSTG.
    
    Parameters:
    
    typeHOSTG - Boolean which is set to true if objects of type HOSTG should be returned.
  - setTypeJOBI
```
public void setTypeJOBI(boolean typeJOBI)
```
    Enables or disables the object type JOBI.
    
    Parameters:
    
    typeJOBI - Boolean which is set to true if objects of type JOBI should be returned.
  - isTypeJOBP
```
public boolean isTypeJOBP()
```
    Returns whether the object type JOBP is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type JOBP is enabled
  - setTypeJOBP
```
public void setTypeJOBP(boolean typeJOBP)
```
    Enables or disables the object type JOBP.
    
    Parameters:
    
    typeJOBP - Boolean which is set to true if objects of type JOBP should be returned.
  - isTypeJOBS
```
public boolean isTypeJOBS()
```
    Returns whether the object type JOBS is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type JOBS is enabled
  - setTypeJOBS
```
public void setTypeJOBS(boolean typeJOBS)
```
    Enables or disables the object type JOBS.
    
    Parameters:
    
    typeJOBS - Boolean which is set to true if objects of type JOBS should be returned.
  - isTypeJSCH
```
public boolean isTypeJSCH()
```
    Returns whether the object type JSCH is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type JSCH is enabled
  - setTypeJSCH
```
public void setTypeJSCH(boolean typeJSCH)
```
    Enables or disables the object type JSCH.
    
    Parameters:
    
    typeJSCH - Boolean which is set to true if objects of type JSCH should be returned.
  - isTypeLOGIN
```
public boolean isTypeLOGIN()
```
    Returns whether the object type LOGIN is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type LOGIN is enabled
  - setTypeLOGIN
```
public void setTypeLOGIN(boolean typeLOGIN)
```
    Enables or disables the object type LOGIN.
    
    Parameters:
    
    typeLOGIN - Boolean which is set to true if objects of type LOGIN should be returned.
  - isTypeSCRI
```
public boolean isTypeSCRI()
```
    Returns whether the object type SCRI is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type SCRI is enabled
  - setTypeSCRI
```
public void setTypeSCRI(boolean typeSCRI)
```
    Enables or disables the object type SCRI.
    
    Parameters:
    
    typeSCRI - Boolean which is set to true if objects of type SCRI should be returned.
  - isTypeSERV
```
public boolean isTypeSERV()
```
    Returns whether the object type SERV is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type SERV is enabled
  - setTypeSERV
```
public void setTypeSERV(boolean typeSERV)
```
    Enables or disables the object type SERV.
    
    Parameters:
    
    typeSERV - Boolean which is set to true if objects of type SERV should be returned.
  - isTypeSYNC
```
public boolean isTypeSYNC()
```
    Returns whether the object type SYNC is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type SYNC is enabled
  - setTypeSYNC
```
public void setTypeSYNC(boolean typeSYNC)
```
    Enables or disables the object type SYNC.
    
    Parameters:
    
    typeSYNC - Boolean which is set to true if objects of type SYNC should be returned.
  - isTypeTZ
```
public boolean isTypeTZ()
```
    Returns whether the object type TZ is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type TZ is enabled
  - setTypeTZ
```
public void setTypeTZ(boolean typeTZ)
```
    Enables or disables the object type TZ.
    
    Parameters:
    
    typeTZ - Boolean which is set to true if objects of type TZ should be returned.
  - isTypeUSER
```
public boolean isTypeUSER()
```
    Returns whether the object type USER is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type USER is enabled
  - setTypeUSER
```
public void setTypeUSER(boolean typeUSER)
```
    Enables or disables the object type USER.
    
    Parameters:
    
    typeUSER - Boolean which is set to true if objects of type USER should be returned.
  - isTypePRPT
```
public boolean isTypePRPT()
```
    Returns whether the object type PRPT is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type PRPT is enabled
  - setTypePRPT
```
public void setTypePRPT(boolean typePRPT)
```
    Enables or disables the object type PRPT.
    
    Parameters:
    
    typePRPT - Boolean which is set to true if objects of type PRPT should be returned.
  - isTypeUSRG
```
public boolean isTypeUSRG()
```
    Returns whether the object type USER is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type USER is enabled
  - setTypeUSRG
```
public void setTypeUSRG(boolean typeUSRG)
```
    Enables or disables the object type USERG.
    
    Parameters:
    
    typeUSRG - Boolean which is set to true if objects of type USERG should be returned.
  - isTypeVARA
```
public boolean isTypeVARA()
```
    Returns whether the object type VARA is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type VARA is enabled
  - setTypeVARA
```
public void setTypeVARA(boolean typeVARA)
```
    Enables or disables the object type VARA.
    
    Parameters:
    
    typeVARA - Boolean which is set to true if objects of type VARA should be returned.
  - isTypeJOBQ
```
public boolean isTypeJOBQ()
```
    Returns whether the object type JOBQ is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type JOBQ is enabled
  - setTypeJOBQ
```
public void setTypeJOBQ(boolean typeJOBQ)
```
    Enables or disables the object type JOBQ.
    
    Parameters:
    
    typeJOBQ - Boolean which is set to true if objects of type JOBQ should be returned.
  - isTypeDASH
```
public boolean isTypeDASH()
```
    Returns whether the object type DASH is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type DASH is enabled
  - setTypeSTORE
```
public void setTypeSTORE(boolean typeSTORE)
```
    Enables or disables the object type STORE.
    
    Parameters:
    
    typeSTORE - Boolean which is set to true if objects of type STORE should be returned.
  - setTypePERIOD
```
public void setTypePERIOD(boolean typePERIOD)
```
    Enables or disables the object type PERIOD.
    
    Parameters:
    
    typePERIOD - Boolean which is set to true if objects of type PERIOD should be returned.
  - isTypeSLO
```
public boolean isTypeSLO()
```
    Returns whether the object type SLO is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type SLO is enabled
  - setTypeSLO
```
public void setTypeSLO(boolean typeSLO)
```
    Enables or disables the object type SLO.
    
    Parameters:
    
    typeSLO - Boolean which is set to true if objects of type SLO should be returned.
  - isTypeSTORE
```
public boolean isTypeSTORE()
```
    Returns whether the object type STORE is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type STORE is enabled
  - isTypePERIOD
```
public boolean isTypePERIOD()
```
    Returns whether the object type STORE is enabled for the search or not.
    
    Returns:
    
    Boolean containing true if the object type STORE is enabled
  - setTypeDASH
```
public void setTypeDASH(boolean typeDASH)
```
    Enables or disables the object type DASH.
    
    Parameters:
    
    typeDASH - Boolean which is set to true if objects of type DASH should be returned.
  - selectAllObjectTypes
```
public void selectAllObjectTypes()
```
    Select all object types.
  - unselectAllObjectTypes
```
public void unselectAllObjectTypes()
```
    Unselect all object types.
  - setNoDateSelection
```
public void setNoDateSelection()
```
    Disables date selection.
  - isNoDateSelection
```
public boolean isNoDateSelection()
```
    Returns true if the date selection is disabled.
    
    Returns:
    
    Boolean which is set to true if date selection is not enabled
  - setDateSelectionCreated
```
public void setDateSelectionCreated(DateTime from,
                                    DateTime to)
```
    Select objects which are created within the specified date range.
    
    Parameters:
    
    from - Begin of the date range
    
    to - End of the date range
  - isDateSelectionCreated
```
public boolean isDateSelectionCreated()
```
    Returns true if the creation date of objects is used in the selection for this search.
    
    Returns:
    
    Boolean indicating whether the creation date is used to find objects
  - setDateSelectionModified
```
public void setDateSelectionModified(DateTime from,
                                     DateTime to)
```
    Select objects which are modified within the specified date range.
    
    Parameters:
    
    from - Begin of the date range
    
    to - End of the date range
  - isDateSelectionModified
```
public boolean isDateSelectionModified()
```
    Returns true if the modification timestamp of objects is used in the selection for this search.
    
    Returns:
    
    Boolean indicating whether the modification timestamp is used to find objects
  - setDateSelectionUsed
```
public void setDateSelectionUsed(DateTime from,
                                 DateTime to)
```
    Select objects which are used within the specified date range.
    
    Parameters:
    
    from - Begin of the date range
    
    to - End of the date range
  - isDateSelectionUsed
```
public boolean isDateSelectionUsed()
```
    Returns true if the last used timestamp of objects is used in the selection for this search.
    
    Returns:
    
    Boolean indicating whether the last used timestamp is used to find objects
  - getFromDate
```
public DateTime getFromDate()
```
    Returns the begin of the date range.
    
    Returns:
    
    DateTime containing the begin of the date range
  - getToDate
```
public DateTime getToDate()
```
    Returns the end of the date range.
    
    Returns:
    
    DateTime containing the end of the date range
  - searchCalendarKeyword
```
public void searchCalendarKeyword(java.lang.String keywordPattern)
```
    Sets a filter to return only CALE objects which contain the specified keywordPattern The default value is *.
    
    Parameters:
    
    keywordPattern - String containing a keyword pattern
  - setTextSearch
```
public void setTextSearch(java.lang.String pattern,
                          boolean process,
                          boolean documentation,
                          boolean objectTitle,
                          boolean archiveKeys)
```
    Search for texts.
    
    Parameters:
    
    pattern - text pattern
    
    process - Include Scripts
    
    documentation - Include documentation content
    
    objectTitle - Include object title
    
    archiveKeys - Include archive keys
  - searchInRAValues
```
public void searchInRAValues(java.lang.String pattern)
```
    Search for RA values.
    
    Parameters:
    
    pattern - Text pattern
  - setSearchInVariable
```
public void setSearchInVariable(java.lang.String pattern,
                                boolean key,
                                boolean value,
                                boolean allValueColumns,
                                SearchObject.VariableDataType dataType)
```
    Searches in UC4 Variable Objects.
    
    Parameters:
    
    pattern - Search pattern
    
    key - Find pattern in key column?
    
    value - Find pattern in value column?
    
    allValueColumns - Find pattern in all value columns
    
    dataType - Type of a variable
  - disableTextSearch
```
public void disableTextSearch()
```
    Disable text search.
  - isAllowedInClientZero
```
protected boolean isAllowedInClientZero()
```
    Description copied from class: XMLRequest
    
    This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.
    
    Overrides:
    
    isAllowedInClientZero in class XMLRequest
    
    Returns:
    
    true if this request is allowed in client 0, false otherwise
  - size
```
public int size()
```
    Returns the number of objects in the search result.
    
    Returns:
    
    number of objects in result

Class SearchObject

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.uc4.communication.requests.XMLRequest

Methods inherited from class java.lang.Object

Constructor Detail

SearchObject

Method Detail

getSrc

createRequest

handleContent

ignoreMessageBox

setTypeExecuteable

resultIterator

isSearchUseOfObjects

setSearchUseOfObjects

isIncludeLinks

setIncludeLinks

setIncludeUseInScripts

getSearchLocation

setSearchLocation

isIncludeSubfolder

getName

setNameAndTitle

setName

isTypeCALE

setTypeCALE

isTypeCITC

setTypeCITC

isTypeCONN

setTypeCONN

isTypeFILTER

isTypeQUEUE

setTypeQUEUE

setTypeFILTER

isTypeHSTA

setTypeHSTA

isTypeXSL

setTypeXSL

isTypeCALL

setTypeCALL

isTypeCLNT

setTypeCLNT

isTypeCODE

setTypeCODE

isTypeCPIT

setTypeCPIT

isTypeDOCU

setTypeDOCU

isTypeEVNT

setTypeEVNT

isTypeFOLD

setTypeFOLD

isTypeHOST

setTypeHOST

isTypeJOBF

setTypeJOBF

isTypeJOBG

setTypeJOBG

isTypeJOBI

isTypeHOSTG

setTypeHOSTG

setTypeJOBI

isTypeJOBP

setTypeJOBP

isTypeJOBS

setTypeJOBS

isTypeJSCH

setTypeJSCH

isTypeLOGIN

setTypeLOGIN

isTypeSCRI

setTypeSCRI

isTypeSERV

setTypeSERV

isTypeSYNC

setTypeSYNC

isTypeTZ

setTypeTZ