Oracle Beehive
  Oracle® Beehive RESTful Web Services API Reference
  Release 2 (2.0.1.7)
  E16658-04

Beehive Development Kit » All Representations » expertiseTopicSearchParameters
Contents

Overview

Represents the parameters to be passed to Expertise Search. This can be supplied with a list of ExpertiseSearchClause types, an ExpertiseTextClauseGenParam type or a string search expression.

Refer to base type expertiseSearchParameters for more information.

Members

Name Type Required Description

excludedOrganizationScopes

expertiseOrganizationScopeType[]
The organization scopes to use in order to exclude a set of profiles from the search

maxSearchMatches

int
Specifies how many of the top search matches are considered when building topics. The operation takes longer as this number is increased.

minProfilesForTopics

int
Minimum number of matching profiles needed in order for topics to be built

orderByStrength

expertiseMatchStrength
Specifies how the matching profiles should be ordered

pagingOptions

numericPagingOptions
The page of search results to return

returnTerms

boolean
Specifies if the matching terms should be returned

reviewed

boolean
Controls if the search should consider terms based on their reviewed status. If not set, the reviewed status of terms will not be considered.

searchClauses

expertiseSearchClauseList
The list of search clauses to use when doing a search

searchExpression

string
the search expression to search on.

The expression supports a rich format. By default a list of words is an OR search. words separated by AND will result in an and search. If words are quoted with " then the words in the quotes is a phrase search. Nesting of expressions is also possible with parentheses (). Lastly, required or do not match is possible with + and - respectively.

Some possible search expressions possible include: A B C -- simple or search A and B and C -- simple and search "A B C" -- simple phrase search "A B" C -- search for phrase A B or C A B -C -- search for A or B or not C (A B) and -C -- search for A or B and not C (A B) and (C D) -- search for A or B and C or D

termVisibility

visibility[]
The visibility of the terms to search against. Note: Only PUBLIC visibility is supported when searching for profiles while either PUBLIC or PROTECTED or both visibilities can be used when searching for Topics. If the visibility is not specified it will default to PUBLIC when searching for profiles and PROTECTED when searching for topics.

textClauseGenParam

expertiseTextClauseGenParam
a body of text and how to generate a search from it

topicSpec

expertiseTopicSpec
If present, specifies how topics should be made for the matching profiles. If it is missing topics will not be generated

userScopes

beeId[]
The scopes identifying profiles to search against

Hierarchy

Inherits From

Examples

Below are examples in JSON and XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

XML Example

(show inherited members)

<obh:expertiseTopicSearchParameters xsi:type="obh:expertiseTopicSearchParameters" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:excludedOrganizationScopes>your_expertiseOrganizationScopeType_0</obh:excludedOrganizationScopes>
        <obh:excludedOrganizationScopes>your_expertiseOrganizationScopeType_1</obh:excludedOrganizationScopes>
        <obh:excludedOrganizationScopes>your_expertiseOrganizationScopeType_2</obh:excludedOrganizationScopes>
         <obh:maxSearchMatches>your_int_0</obh:maxSearchMatches>
         <obh:minProfilesForTopics>your_int_0</obh:minProfilesForTopics>
         <obh:orderByStrength>your_expertiseMatchStrength_0</obh:orderByStrength>
         <obh:pagingOptions>your_numericPagingOptions_0</obh:pagingOptions>
         <obh:returnTerms>your_boolean_0</obh:returnTerms>
         <obh:reviewed>your_boolean_0</obh:reviewed>
         <obh:searchClauses>your_expertiseSearchClauseList_0</obh:searchClauses>
         <obh:searchExpression>your_string_0</obh:searchExpression>
         <obh:termVisibility>your_visibility_0</obh:termVisibility>
        <obh:termVisibility>your_visibility_1</obh:termVisibility>
        <obh:termVisibility>your_visibility_2</obh:termVisibility>
         <obh:textClauseGenParam>your_expertiseTextClauseGenParam_0</obh:textClauseGenParam>
         <obh:topicSpec>your_expertiseTopicSpec_0</obh:topicSpec>
         <obh:userScopes>your_beeId_0</obh:userScopes>
        <obh:userScopes>your_beeId_1</obh:userScopes>
        <obh:userScopes>your_beeId_2</obh:userScopes>
 </obh:expertiseTopicSearchParameters>

JSON Example

(show inherited members)

{
    "beeType":"expertiseTopicSearchParameters",
        "excludedOrganizationScopes":[
            { your_{http://www.oracle.com/beehive}excludedOrganizationScopes_as_expertiseOrganizationScopeType0 },
            { your_{http://www.oracle.com/beehive}excludedOrganizationScopes_as_expertiseOrganizationScopeType1 },
            { your_{http://www.oracle.com/beehive}excludedOrganizationScopes_as_expertiseOrganizationScopeType2 }
        ],
         "maxSearchMatches":your_{http://www.oracle.com/beehive}maxSearchMatches_as_int0,
         "minProfilesForTopics":your_{http://www.oracle.com/beehive}minProfilesForTopics_as_int0,
         "orderByStrength":{ your_{http://www.oracle.com/beehive}orderByStrength_as_expertiseMatchStrength0 },
         "pagingOptions":{ your_{http://www.oracle.com/beehive}pagingOptions_as_numericPagingOptions0 },
         "returnTerms":your_{http://www.oracle.com/beehive}returnTerms_as_boolean0,
         "reviewed":your_{http://www.oracle.com/beehive}reviewed_as_boolean0,
         "searchClauses":{ your_{http://www.oracle.com/beehive}searchClauses_as_expertiseSearchClauseList0 },
         "searchExpression":"your_{http://www.oracle.com/beehive}searchExpression_as_string0",
         "termVisibility":[
            { your_{http://www.oracle.com/beehive}termVisibility_as_visibility0 },
            { your_{http://www.oracle.com/beehive}termVisibility_as_visibility1 },
            { your_{http://www.oracle.com/beehive}termVisibility_as_visibility2 }
        ],
         "textClauseGenParam":{ your_{http://www.oracle.com/beehive}textClauseGenParam_as_expertiseTextClauseGenParam0 },
         "topicSpec":{ your_{http://www.oracle.com/beehive}topicSpec_as_expertiseTopicSpec0 },
         "userScopes":[
            { your_{http://www.oracle.com/beehive}userScopes_as_beeId0 },
            { your_{http://www.oracle.com/beehive}userScopes_as_beeId1 },
            { your_{http://www.oracle.com/beehive}userScopes_as_beeId2 }
        ]
 }

XML Schema


<xs:complexType name="expertiseTopicSearchParameters">
    <xs:complexContent>
        <xs:extension base="tns:expertiseSearchParameters">
            <xs:sequence>
                <xs:element minOccurs="0" name="maxSearchMatches" type="xs:int"/>
                <xs:element minOccurs="0" name="minProfilesForTopics" type="xs:int"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

References

The following data represents the references to expertiseTopicSearchParameters

Referenced By Resources

Usage Resource Method
Request Expertise Management Search Topics

Referenced By Representaions

Not Referenced Directly by Representations

Oracle Logo
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices