Package de.elo.ix.client

Class FindResult

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.FindResult
All Implemented Interfaces:
Serializable
public class FindResult extends ValueClass implements Serializable

This class contains the search results of a call to IXServicePortIF.findFirstSords

or IXServicePortIF.findNextSords.

Copyright: Copyright (c) 2004

Organisation: ELO Digital Office GmbH

See Also:

  • Field Details

    • breakTimeout

      protected boolean breakTimeout
      The time limit for the search is exceeded.

    • breakTotalCount

      protected boolean breakTotalCount
      The search is breaked because the total number of results are reached.

    • configFiles

      protected ConfigFile[] configFiles
      Array of configuration files.

    • ids

      protected String[] ids
      Array of IDs or GUIDs found.

    • moreResults

      protected boolean moreResults
      Is true if there are more results.

    • reportInfos

      protected ReportInfo[] reportInfos
      Report entries.
      See Also:

    • count

      protected int count
      Number of results. This member is only valid, if FindInfo.findOptions.evalCount is true.
      See Also:

    • estimatedCount

      protected int estimatedCount
      Estimated number of hits that can be found by the query. This number cannot be computed for any search and is usually -1. Only if the search engine supplies an estimated count, it is >= 0.
      Since:
      7.00.040.004

    • searchId

      protected String searchId
      Identifier to get more results.

    • sords

      protected Sord[] sords
      Array of sord objects. This member is set if sordC

    • tasks

      protected UserTask[] tasks
      Array of user tasks.
      See Also:

    • workflows

      protected WFDiagram[] workflows
      Array of WorkflowDiagrams
      Since:
      6.00.094
      See Also:

    • translateTerms

      protected TranslateTerm[] translateTerms
      Array of terms translated into different languages.
      Since:
      7.00.000.000
      See Also:

    • fulltextResultItems

      protected FindByFulltextResultItem[] fulltextResultItems
      Additional information from the fulltext database. This member can be null, if the fulltext engine does not support additional information.
      Since:
      7.00.040.002

    • fulltextCtrlResultItems

      protected FindByFulltextCtrlResultItem[] fulltextCtrlResultItems
      Result items returned from a seach for new information to be added into the fulltext database.
      Since:
      7.00.040.008

    • dynamicFolder

      protected String dynamicFolder
      String representation of FindInfo used to define a dynamic register. Function IXServicePortIF.findFirstSords(ClientInfo, FindInfo, int, SordZ) returns a serialized FindInfo in this member. It can be used to define a dynamic register by setting Sord.desc=FindResult.dynamicFolder.
      Since:
      8.00.020.006

    • jobStates

      protected JobState[] jobStates
      Result items returned from a search for background threads.
      Since:
      8.00.036.000

    • actions

      protected Action[] actions
      Document feed actions. This array is filled by findFirst/findNextActions of the interface FeedService. The associated Feed objects are returned in the collection feeds.
      Since:
      9.00.000.003
      See Also:

    • feeds

      protected Map<String,Feed> feeds
      Document feeds. Feed objects mapped to their GUID.
      Since:
      9.00.000.004
      See Also:

    • subscriptions

      protected Map<String,Subscription> subscriptions
      Subscriptions. Subscription objects mapped to their Subscription.watchGuid.
      Since:
      9.00.014.003

    • notifications

      protected Map<String,Notification> notifications
      Notifications. Notification objects mapped to their Notification.watchGuid
      Since:
      9.00.022.006

    • hashTagRelations

      protected List<HashTagRelation> hashTagRelations
      HashTag Relations.
      Since:
      9.00.022.015

    • hashTags

      protected Map<String,HashTag> hashTags
      HashTags. HashTag Objects mapped to their HashTagGuid
      Since:
      9.00.022.020

    • notes

      protected List<Note> notes
      Notes. This member returns the note objects found by findFirstNotes/findNextNotes.
      Since:
      9.00.016.003

    • userInfos

      protected Map<Integer,UserInfo> userInfos
      User objects. Map of user ID to user object.
      Since:
      9.00.050.001

    • userNames

      protected Map<Integer,UserName> userNames
      Lean user objects. Map of user ID to user object.
      Since:
      9.00.050.001

    • contextTerms

      protected List<ContextTermResults> contextTerms
      Result for findContextTerms().
      Since:
      11.00.000.009

    • aggregations

      protected Map<String,AggregationResult> aggregations
      Result for findAggregations().
      Since:
      21.03.000.001

    • completions

      protected List<String> completions
      Type-as-you-search Results.
      Since:
      11.00.000.009

    • corrections

      protected List<String> corrections
      Corrections suggestions.
      Since:
      11.00.000.009

    • synonyms

      protected List<String> synonyms
      Thesaurus Resluts.
      Since:
      11.00.000.009

    • sortedResult

      protected List<ValueClass> sortedResult
      List of result objects ordered by the given sort order. If this member is not null, it repeats the list of result objects in sorted order. This member is only valid if returned from IXServicePortIF.findFirstUsers(ClientInfo, FindUserInfo, int) or IXServicePortIF.findNextUsers(ClientInfo, String, int, int).
      Since:
      11.00.000.028

    • masks

      protected Map<Integer,DocMask> masks
      Keywording forms related to getSords(). This member is set, if FindOptions.docMaskZ is not null and not empty.
      Since:
      12.00.000.024

  • Constructor Details

    • FindResult

      public FindResult()
      Constructor

    • FindResult

      public FindResult(FindResult rhs)
      Copy constructor
      Parameters:
      rhs - Other FindResult object

  • Method Details

    • isBreakTimeout

      public boolean isBreakTimeout()

    • setBreakTimeout

      public void setBreakTimeout(boolean breakTimeout)

    • isBreakTotalCount

      public boolean isBreakTotalCount()

    • setBreakTotalCount

      public void setBreakTotalCount(boolean breakTotalCount)

    • getConfigFiles

      public ConfigFile[] getConfigFiles()

    • setConfigFiles

      public void setConfigFiles(ConfigFile[] configFiles)

    • getIds

      public String[] getIds()

    • getActiveWorkflows

      @Deprecated public WFDiagram[] getActiveWorkflows()
      Deprecated.
      use getWorkflows()
      Get member workflows.
      Returns:
      workflows

    • setIds

      public void setIds(String[] ids)

    • isMoreResults

      public boolean isMoreResults()

    • setMoreResults

      public void setMoreResults(boolean moreResults)

    • getReportInfos

      public ReportInfo[] getReportInfos()

    • setReportInfos

      public void setReportInfos(ReportInfo[] reportInfos)

    • getSearchId

      public String getSearchId()

    • setSearchId

      public void setSearchId(String searchId)

    • getSords

      public Sord[] getSords()

    • setSords

      public void setSords(Sord[] sords)

    • getTasks

      public UserTask[] getTasks()

    • setTasks

      public void setTasks(UserTask[] tasks)

    • setActiveWorkflows

      @Deprecated public void setActiveWorkflows(WFDiagram[] activeWorkflows)
      Deprecated.
      use setWorkflows(WFDiagram[])
      Set member workflows.
      Parameters:
      activeWorkflows - Deprecated

    • getCount

      public int getCount()

    • setCount

      public void setCount(int count)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getContextTerms

      public List<ContextTermResults> getContextTerms()

    • getCompletions

      public List<String> getCompletions()

    • getCorrections

      public List<String> getCorrections()

    • getSynonyms

      public List<String> getSynonyms()

    • setContextTerms

      public void setContextTerms(List<ContextTermResults> contextTerms)

    • setCompletions

      public void setCompletions(List<String> completions)

    • setCorrections

      public void setCorrections(List<String> corrections)

    • setSynonyms

      public void setSynonyms(List<String> synonyms)

    • getAggregations

      public Map<String,AggregationResult> getAggregations()

    • setAggregations

      public void setAggregations(Map<String,AggregationResult> aggregations)

    • getFulltextResultItems

      public FindByFulltextResultItem[] getFulltextResultItems()

    • setFulltextResultItems

      public void setFulltextResultItems(FindByFulltextResultItem[] fulltextResultItems)

    • getFulltextCtrlResultItems

      public FindByFulltextCtrlResultItem[] getFulltextCtrlResultItems()

    • setFulltextCtrlResultItems

      public void setFulltextCtrlResultItems(FindByFulltextCtrlResultItem[] fulltextCtrlResultItems)

    • getWorkflows

      public WFDiagram[] getWorkflows()

    • setWorkflows

      public void setWorkflows(WFDiagram[] workflows)

    • getTranslateTerms

      public TranslateTerm[] getTranslateTerms()

    • setTranslateTerms

      public void setTranslateTerms(TranslateTerm[] terms)

    • getEstimatedCount

      public int getEstimatedCount()

    • setEstimatedCount

      public void setEstimatedCount(int estimatedCount)

    • getDynamicFolder

      public String getDynamicFolder()

    • setDynamicFolder

      public void setDynamicFolder(String dynamicFolder)

    • getJobStates

      public JobState[] getJobStates()

    • setJobStates

      public void setJobStates(JobState[] jobStates)

    • getActions

      public Action[] getActions()

    • setActions

      public void setActions(Action[] actions)

    • getFeeds

      public Map<String,Feed> getFeeds()

    • setFeeds

      public void setFeeds(Map<String,Feed> feeds)

    • getSubscriptions

      public Map<String,Subscription> getSubscriptions()

    • setSubscriptions

      public void setSubscriptions(Map<String,Subscription> subscriptions)

    • setNotifications

      public void setNotifications(Map<String,Notification> notifications)

    • getNotifications

      public Map<String,Notification> getNotifications()

    • getNotes

      public List<Note> getNotes()

    • setNotes

      public void setNotes(List<Note> notes)

    • setHashTags

      public void setHashTags(Map<String,HashTag> hashTags)

    • setHashTag

      public void setHashTag(HashTag hashTag)

    • getHashTags

      public Map<String,HashTag> getHashTags()

    • setHashTagRelations

      public void setHashTagRelations(List<HashTagRelation> hashTagRelations)

    • getHashTagRelations

      public List<HashTagRelation> getHashTagRelations()

    • getUserInfos

      public Map<Integer,UserInfo> getUserInfos()

    • setUserInfos

      public void setUserInfos(Map<Integer,UserInfo> users)

    • getUserNames

      public Map<Integer,UserName> getUserNames()

    • setUserNames

      public void setUserNames(Map<Integer,UserName> userNames)

    • getSortedResult

      public List<ValueClass> getSortedResult()

    • setSortedResult

      public void setSortedResult(List<ValueClass> sortedResult)

    • getMasks

      public Map<Integer,DocMask> getMasks()

    • setMasks

      public void setMasks(Map<Integer,DocMask> masks)