Package de.elo.ix.client

Class FindOptions

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.FindOptions
All Implemented Interfaces:
Serializable
public class FindOptions extends ValueClass implements Serializable
This class contains several options to control the search process of findFirstSords.
See Also:

  • Field Details

    • escapeChar

      protected String escapeChar
      SQL escape character. Overwrites the character that can be specified by setSessionOptions.
      See Also:

    • inclDeleted

      protected boolean inclDeleted
      Include logically deleted objects.
      See Also:

    • objIds

      protected String[] objIds
      Restricts the results to objects with these IDs or GUIDs.

    • orderBy

      protected String orderBy
      An SQL ORDER BY clause can be provided here, if required.

    • rangeDelimiter

      protected String rangeDelimiter
      Range values can be used to search many index and date attribute values. The delimiter between the lower limit and upper limit value is defined by rangeDelimiter. The default rangeDelimiter is "...".

    • replSet

      protected ReplSet replSet
      Results are returned only for objects that reside in this replication set.

    • reserved

      protected long reserved
      This value is reserved for internal testing purposes and must be set to 0 in all cases.

    • searchId

      protected String searchId
      Restricts the results to objects returned by a previous search.

    • searchMode

      protected SearchModeZ searchMode
      The searchMode describes how search terms are concatinated with the boolean operators AND or OR.

    • sortOrder

      protected int sortOrder
      Defines the sort order of the results. If sortOrder is 0 and the search process searches for child objects (FindInfo.findChildren!=null), the objects are sorted by the sort flags of the parent. If sortOrder is 0 and the search uses FindInfo.findByIndex, the objects are sorted alphabetically.
      See Also:

    • timeoutSeconds

      protected int timeoutSeconds
      Specifies the time limit for the search. If the limit is exceeded, the search is interruped. If the search is not to have a time limit timeoutSeconds=0 must be used.

    • totalCount

      protected int totalCount
      The search is terminated if this number of objects are found. If the number of results should not be constrained, set this value to 2^32-1 = 2147483647 (maximum value of a positive 32bit integer minus 1). If totalCount is not set, the Indexserver option totalCount is used, which is 10000 by default. If this value is set to 1, findFirstSords will not generate a report entry ReportInfoC.ACT_CLIENT_SEARCH.

    • evalCount

      protected boolean evalCount
      Compute the number of results. The number of results are returned in FindResult.count. Be aware of the fact that this option needs to read all database result rows and check user access before findFirstSords returns.
      See Also:

    • onlyDeleted

      protected boolean onlyDeleted
      Only logically deleted objects. If this member is true, inclDeleted is ignored.
      Since:
      7.00.000.022
      See Also:

    • TStamp

      protected String TStamp
      Return objects that were last modified at this time or in this time range. The time stamp is an ISO formatted value in the UTC timezone. It might include dots to separate the date and time elements. A time range is separated by the rangeDelimiter. The selection includes the range limits. Because the FindOptions cannot be the only criteria in FindInfo, use FindByIndex.name="*" to select over the entire archive.
      Since:
      7.00.006.001

    • wildcards

      protected String wildcards
      This characters are used as wildcards in search terms. The first wildcard is used for zero or more characters. The second wildcard is used for exactly one character. By default (if this member is null or empty), only the first wildcard is defined: *.
      Since:
      7.00.022.002
      See Also:

    • lockZ

      protected LockZ lockZ
      Lock all result Sords. If at least one of the sords cannot be locked, an exception is thrown from findFirstSords. Be aware of the fact that this option needs to read all database result rows and check user access. The objects are unlocked by a call to findClose.
      Since:
      7.00.022.004

    • searchLifetimeSeconds

      protected int searchLifetimeSeconds
      Lifetime of cached search results. This value overrides the ELOix configuration option searchLifetimeSeconds. The value determines the time in seconds, how long the search results are cached. As long the results are valid, they can be read by findNext-functions of the API.
      Since:
      8.00.026.000
      See Also:

    • excludeSummary

      protected boolean excludeSummary
      Do not generate summary information. Retrieving summaries is very expensive for the iSearch module.
      Since:
      8.00.026.000

    • findResultAccessMode

      protected FindResultAccessMode findResultAccessMode
      Describes how the client application will access the results.
      Since:
      11.00.000.033

    • docMaskZ

      protected DocMaskZ docMaskZ
      Since:
      12.00.000.024

  • Constructor Details

    • FindOptions

      public FindOptions()

    • FindOptions

      public FindOptions(FindOptions rhs)

  • Method Details

    • getEscapeChar

      public String getEscapeChar()

    • setEscapeChar

      public void setEscapeChar(String escapeChar)

    • isInclDeleted

      public boolean isInclDeleted()

    • setInclDeleted

      public void setInclDeleted(boolean inclDeleted)

    • getObjIds

      public String[] getObjIds()

    • setObjIds

      public void setObjIds(String[] objIds)

    • getOrderBy

      public String getOrderBy()

    • setOrderBy

      public void setOrderBy(String orderBy)

    • getRangeDelimiter

      public String getRangeDelimiter()

    • setRangeDelimiter

      public void setRangeDelimiter(String rangeDelimiter)

    • getReplSet

      public ReplSet getReplSet()

    • setReplSet

      public void setReplSet(ReplSet replSet)

    • getReserved

      public long getReserved()

    • setReserved

      public void setReserved(long reserved)

    • getSearchId

      public String getSearchId()

    • setSearchId

      public void setSearchId(String searchId)

    • getSearchMode

      public SearchModeZ getSearchMode()

    • setSearchMode

      public void setSearchMode(SearchModeZ searchMode)

    • getSortOrder

      public int getSortOrder()

    • setSortOrder

      public void setSortOrder(int sortOrder)

    • getTimeoutSeconds

      public int getTimeoutSeconds()

    • setTimeoutSeconds

      public void setTimeoutSeconds(int timeoutSeconds)

    • getTotalCount

      public int getTotalCount()

    • setTotalCount

      public void setTotalCount(int totalCount)

    • isEvalCount

      public boolean isEvalCount()

    • setEvalCount

      public void setEvalCount(boolean evalCount)

    • isOnlyDeleted

      public boolean isOnlyDeleted()

    • setOnlyDeleted

      public void setOnlyDeleted(boolean onlyDeleted)

    • getTStamp

      public String getTStamp()

    • setTStamp

      public void setTStamp(String stamp)

    • getWildcards

      public String getWildcards()

    • setWildcards

      public void setWildcards(String wildcards)

    • getLockZ

      public LockZ getLockZ()

    • setLockZ

      public void setLockZ(LockZ lockZ)

    • getSearchLifetimeSeconds

      public int getSearchLifetimeSeconds()

    • setSearchLifetimeSeconds

      public void setSearchLifetimeSeconds(int searchLifetimeSeconds)

    • isExcludeSummary

      public boolean isExcludeSummary()

    • setExcludeSummary

      public void setExcludeSummary(boolean excludeSummary)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getFindResultAccessMode

      public FindResultAccessMode getFindResultAccessMode()

    • setFindResultAccessMode

      public void setFindResultAccessMode(FindResultAccessMode findResultAccessMode)

    • getDocMaskZ

      public DocMaskZ getDocMaskZ()

    • setDocMaskZ

      public void setDocMaskZ(DocMaskZ docMaskZ)