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

Beehive Development Kit » All Representations » expertiseTopicClauses
Contents

Overview

Represents a list of one or more TopicClause objects, each specifying a type of topic to return. Includes a parameter to specify whether or not the terms associated with each topic should be returned. The language to consider can also be specified. Note that the same keyword will not be used as the basis for more than one topic, even for topics of different types.

Members

Name Type Required Description

clauses

expertiseTopicClause[]
The list of ExpertiseTopicClauses.

maxTermsPerTopic

int
The maximum number of terms to return with each topic.

pagingOptions

numericPagingOptions
The NumericPagingOptions indicating the row information used to control the number of topics to display in each "page" of results. NULL is a valid value. The default value is "0". This attribute can be used to make the display of results more manageable. For example, you could enable an interface to "page through" topics by displaying topics 0-10, 11-20, and so on.

returnDistinctTerms

expertiseTopicClausesDistinctTerms
The level of uniqueness required for terms within topics.

returnMatchingTermSets

boolean
Get whether to return terms that match the request criteria with the corresponding topic.

returnOnlyTopNTopicPerKeywordSet

int
The number of topics to return per keyword set. If non-zero, the resulting topics will be pruned to only include the best topic per keyword set. If zero, all matching topics are returned. For example, if set to "1", only one topic matching the keyword set database (management, administrator) would be returned.

topicLanguage

int
The Language(s) to limit topics to. Set to ExpertiseLanguage.LANGUAGE_UNSPECIFIED

Hierarchy

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:expertiseTopicClauses xsi:type="obh:expertiseTopicClauses" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:clauses>your_expertiseTopicClause_0</obh:clauses>
        <obh:clauses>your_expertiseTopicClause_1</obh:clauses>
        <obh:clauses>your_expertiseTopicClause_2</obh:clauses>
         <obh:maxTermsPerTopic>your_int_0</obh:maxTermsPerTopic>
         <obh:pagingOptions>your_numericPagingOptions_0</obh:pagingOptions>
         <obh:returnDistinctTerms>your_expertiseTopicClausesDistinctTerms_0</obh:returnDistinctTerms>
         <obh:returnMatchingTermSets>your_boolean_0</obh:returnMatchingTermSets>
         <obh:returnOnlyTopNTopicPerKeywordSet>your_int_0</obh:returnOnlyTopNTopicPerKeywordSet>
         <obh:topicLanguage>your_int_0</obh:topicLanguage>
 </obh:expertiseTopicClauses>

JSON Example

(show inherited members)

{
    "beeType":"expertiseTopicClauses",
        "clauses":[
            { your_{http://www.oracle.com/beehive}clauses_as_expertiseTopicClause0 },
            { your_{http://www.oracle.com/beehive}clauses_as_expertiseTopicClause1 },
            { your_{http://www.oracle.com/beehive}clauses_as_expertiseTopicClause2 }
        ],
         "maxTermsPerTopic":your_{http://www.oracle.com/beehive}maxTermsPerTopic_as_int0,
         "pagingOptions":{ your_{http://www.oracle.com/beehive}pagingOptions_as_numericPagingOptions0 },
         "returnDistinctTerms":{ your_{http://www.oracle.com/beehive}returnDistinctTerms_as_expertiseTopicClausesDistinctTerms0 },
         "returnMatchingTermSets":your_{http://www.oracle.com/beehive}returnMatchingTermSets_as_boolean0,
         "returnOnlyTopNTopicPerKeywordSet":your_{http://www.oracle.com/beehive}returnOnlyTopNTopicPerKeywordSet_as_int0,
         "topicLanguage":your_{http://www.oracle.com/beehive}topicLanguage_as_int0
 }

XML Schema


<xs:complexType name="expertiseTopicClauses">
    <xs:sequence>
        <xs:element maxOccurs="unbounded" minOccurs="0" name="clauses"
            nillable="true" type="tns:expertiseTopicClause"/>
        <xs:element name="maxTermsPerTopic" type="xs:int"/>
        <xs:element minOccurs="0" name="pagingOptions" type="tns:numericPagingOptions"/>
        <xs:element minOccurs="0" name="returnDistinctTerms" type="tns:expertiseTopicClausesDistinctTerms"/>
        <xs:element name="returnMatchingTermSets" type="xs:boolean"/>
        <xs:element name="returnOnlyTopNTopicPerKeywordSet" type="xs:int"/>
        <xs:element name="topicLanguage" type="xs:int"/>
    </xs:sequence>
</xs:complexType>

References

The following data represents the references to expertiseTopicClauses

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions

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