Skip navigation links

oracle.wcps.activity.provider
Class AGFunctionProvider

java.lang.Object
oracle.wcps.activity.provider.AGFunctionProvider

@FunctionProvider(prefix="agfunction",
                  resourceBundle="oracle.wcps.activity.provider.resources.AGFunctionProviderResources",
                  nameBundleKey="provider.name",
                  descriptionBundleKey="provider.description")
public class AGFunctionProvider

extends java.lang.Object

This class provides utility methods to filter out content IDs from the AG REST call results.

Constructor Summary

AGFunctionProvider()

Method Summary

static Recommendations	filterRecsByScore(Recommendations recs, float cutoffScore) Filter recommendations by score.
static java.util.List<java.lang.String>	getCMISLinksFromCommonItems(Results results) Return the a List of URLs to the WebCenter resource representing these Results (from common items)
static java.util.List<java.lang.String>	getCMISLinksFromRecommendations(Recommendations recommendations) Return the a List of URLs to the WebCenter resource representing these Recommendations
static java.util.List<java.lang.String>	getContentIDs(java.lang.Object agResults) Return the value of 'ObjectURN' for the 'ClassURN' from the input Object.
static java.util.List<java.lang.String>	getContentIDsExclude(java.lang.Object agResults, java.lang.String excludeClassURN) Return the value of 'ObjectURN' for the 'ClassURN' from the input Object.
static java.util.List<java.lang.String>	getContentIDsFiltered(java.lang.Object agResults, java.lang.String filterClassURN) Return the value of 'ObjectURN' for the 'ClassURN' from the input Object.
static java.util.List<java.lang.String>	getListFromCommaDelimitedString(java.lang.String s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AGFunctionProvider

public AGFunctionProvider()

Method Detail

getContentIDs

@PublicFunction(functionName="getContentIDs",
                descriptionBundleKey="getContentIDs.method.description")
public static java.util.List<java.lang.String> getContentIDs(@PublicParameter(parameterName="agResults",descriptionBundleKey="getContentIDs.parameter.description.agResults")
                                                                                                            java.lang.Object agResults)

Return the value of 'ObjectURN' for the 'ClassURN' from the input Object.

Parameters:

agResults - From call to 'QueryRecommendations' or QueryItems. Can be one of the following Classes: From AG REST 'recommendations'

• Recommendations
• RecommendedItems
• List<Recommendation>

From AG REST 'items' (common items)

• Results
• Items
• List<Item>

Returns:

getContentIDsFiltered

@PublicFunction(functionName="getContentIDsFiltered",
                descriptionBundleKey="getContentIDsFiltered.method.description")
public static java.util.List<java.lang.String> getContentIDsFiltered(@PublicParameter(parameterName="agResults",descriptionBundleKey="getContentIDsFiltered.parameter.description.agResults")
                                                                                                                    java.lang.Object agResults,
                                                                                                                    @PublicParameter(parameterName="filterClassURN",descriptionBundleKey="getContentIDsFiltered.parameter.description.filterClassURN")
                                                                                                                    java.lang.String filterClassURN)

Return the value of 'ObjectURN' for the 'ClassURN' from the input Object.

Parameters:

agResults - From call to 'QueryRecommendations' or QueryItems. Can be one of the following Classes: From AG REST 'recommendations'

• Recommendations
• RecommendedItems
• List<Recommendation>

From AG REST 'items' (common items)

• Results
• Items
• List<Item>

filterClassURN - return content only of this type. Examples are: WC.wiki-page, WC.group-space, WC.user, WC.blog, WC.topic, WC.document. If this is null, return all types. To specify multiple classURNs, input a comma-delimited String

Returns:

getContentIDsExclude

@PublicFunction(functionName="getContentIDsFiltered",
                descriptionBundleKey="getContentIDsFiltered.method.description")
public static java.util.List<java.lang.String> getContentIDsExclude(@PublicParameter(parameterName="agResults",descriptionBundleKey="getContentIDsFiltered.parameter.description.agResults")
                                                                                                                   java.lang.Object agResults,
                                                                                                                   @PublicParameter(parameterName="excludeClassURN",descriptionBundleKey="getContentIDsFiltered.parameter.description.filterClassURN")
                                                                                                                   java.lang.String excludeClassURN)

Return the value of 'ObjectURN' for the 'ClassURN' from the input Object.

Parameters:

agResults - From call to 'QueryRecommendations' or QueryItems. Can be one of the following Classes: From AG REST 'recommendations'

• Recommendations
• RecommendedItems
• List<Recommendation>

From AG REST 'items' (common items)

• Results
• Items
• List<Item>

excludeClassURN - return content only of this type. Examples are: WC.wiki-page, WC.group-space, WC.user, WC.blog, WC.topic, WC.document. If this is null, return all types. To specify multiple classURNs, input a comma-delimited String

Returns:

filterRecsByScore

@PublicFunction(functionName="filterRecsByScore",
                descriptionBundleKey="filterRecsByScore.method.description")
public static Recommendations filterRecsByScore(@PublicParameter(parameterName="recommendations",descriptionBundleKey="filterRecsByScore.parameter.description.agRecs")
                                                                                               Recommendations recs,
                                                                                               @PublicParameter(parameterName="cutoffScore",descriptionBundleKey="filterRecsByScore.parameter.description.cutoffScore")
                                                                                               float cutoffScore)

Filter recommendations by score. Only those recommendations with a score >= the cutoff will be preserved.

getCMISLinksFromRecommendations

@PublicFunction(functionName="getCMISLinksFromRecommendations",
                descriptionBundleKey="getCMISLinksFromRecommendations.method.description")
public static java.util.List<java.lang.String> getCMISLinksFromRecommendations(@PublicParameter(parameterName="recommendations",descriptionBundleKey="getCMISLinksFromRecommendations.parameter.description.recommendations")
                                                                                                                              Recommendations recommendations)

Return the a List of URLs to the WebCenter resource representing these Recommendations

Parameters:

recommendations -

Returns:

getCMISLinksFromCommonItems

@PublicFunction(functionName="getCMISLinksFromCommonItems",
                descriptionBundleKey="getCMISLinksFromCommonItems.method.description")
public static java.util.List<java.lang.String> getCMISLinksFromCommonItems(@PublicParameter(parameterName="results",descriptionBundleKey="getCMISLinksFromCommonItems.parameter.description.results")
                                                                                                                          Results results)

Return the a List of URLs to the WebCenter resource representing these Results (from common items)

Parameters:

results - The Results object returned from the AG common items provider call

Returns:

getListFromCommaDelimitedString

public static java.util.List<java.lang.String> getListFromCommaDelimitedString(java.lang.String s)

Skip navigation links