com.plumtree.server
Interface IPTCatalogStatistics

All Superinterfaces:

IPTUnknown

public interface IPTCatalogStatistics
extends IPTUnknown

Version:

$Revision$

Author:

Stephen Chang

Method Summary

void	DecreaseCardPopularityWeight(double dblPercentDecreaseInWeight, int nCardID) Decreases the popularity of a Card by a percentage
int	GetPopularitySamplingRate() Returns the popularity sampling rate.
IPTQueryResult	QueryCardPopularityStatistics(int nCardID) Returns basic information about a card including the popularity
IPTQueryResult	QueryLeastPopularCommunityContent(int nClassID, int nCount) Queries communities for least popular content.
IPTQueryResult	QueryLeastPopularContent(int nClassID, int nCount) Queries user MyPages for least popular content.
IPTQueryResult	QueryMostPopularCommunityContent(int nClassID, int nCount) Queries communities for popular content.
IPTQueryResult	QueryMostPopularContent(int nClassID, int nCount) Queries user MyPages for popular content.
IPTQueryResult	QueryPopularCardsByBranch(int nFolderID, int lSkipRows, int lMaxRows, int lPropIDMask, java.lang.Object[][] vQueryFilter) Queries for Cards in a Folder branch sorted by popularity
IPTQueryResult	QueryPopularCardsByFolder(int nFolderID, int lSkipRows, int lMaxRows, int lPropIDMask, java.lang.Object[][] vQueryFilter) Queries for Cards in a Folder sorted by popularity
IPTQueryResult	QueryUnpopularCardsByBranch(int nFolderID, com.plumtree.openfoundation.util.XPDateTime dtNotAccessedSince, int nPopularityThreshold, int lSkipRows, int lMaxRows, int lPropIDMask, java.lang.Object[][] vQueryFilter) Returns the least popular Cards in a Folder branch that have either not been accessed since a given date or have a popularity lower than a given threshhold.
IPTQueryResult	QueryUnpopularCardsByFolder(int nFolderID, com.plumtree.openfoundation.util.XPDateTime dtNotAccessedSince, int nPopularityThreshold, int lSkipRows, int lMaxRows, int lPropIDMask, java.lang.Object[][] vQueryFilter) Returns the least popular Cards in a Folder that have either not been accessed since a given date or have a popularity lower than a given threshhold.
void	ReportCardAccess(int lCard) Reports to the statistics maintainer that the card passed in has been accessed.
void	SetPopularitySamplingRate(int Value) Sets the popularity sample rate.

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

GetPopularitySamplingRate

int GetPopularitySamplingRate()

Returns the popularity sampling rate.

Returns:

Popularity Rate

SetPopularitySamplingRate

void SetPopularitySamplingRate(int Value)

Sets the popularity sample rate.

Parameters:

Value - The sampling rate is not persisted on the server.

ReportCardAccess

void ReportCardAccess(int lCard)

Reports to the statistics maintainer that the card passed in has been accessed. The sampling rate is used to control when the statistic is actually updated in the database in order to limit the number of database calls.

Parameters:

lCard - cardID of the Card being accessed.

DecreaseCardPopularityWeight

void DecreaseCardPopularityWeight(double dblPercentDecreaseInWeight,
                                  int nCardID)

Decreases the popularity of a Card by a percentage

Parameters:

dblPercentDecreaseInWeight - percentage that the popularity will be decreased

nCardID - cardID of the Card

QueryCardPopularityStatistics

IPTQueryResult QueryCardPopularityStatistics(int nCardID)

Returns basic information about a card including the popularity

Parameters:

nCardID - cardID of the Card being queried

Returns:

IPTQueryResult containing the following columns: PT_PROPID_OBJECTID, PT_PROPID_NAME, PT_PROPID_DESCRIPTION, PT_PROPID_CREATED, PT_PROPID_LASTMODIFIED, PT_PROPID_IMAGEUUID, PT_PROPID_CARD_URL, PT_PROPID_CARD_NUMPARENTS, PT_PROPID_CARD_DATASOURCEID, PT_PROPID_CARD_CRAWLERID, PT_PROPID_CARD_DOCUMENTTYPEID, PT_PROPIDS.PT_PROPID_CARD_POPULARITY, PT_PROPIDS.PT_PROPID_CARD_ACCESSCOUNT, PT_PROPIDS.PT_PROPID_CARD_LASTACCESS

QueryPopularCardsByFolder

IPTQueryResult QueryPopularCardsByFolder(int nFolderID,
                                         int lSkipRows,
                                         int lMaxRows,
                                         int lPropIDMask,
                                         java.lang.Object[][] vQueryFilter)

Queries for Cards in a Folder sorted by popularity

Parameters:

nFolderID - folderID of the Folder being queried

lSkipRows - number of cards to skip

lMaxRows - maximum number of Cards to return

lPropIDMask - propertyIDs to return

vQueryFilter - filter to be applied to the query

Returns:

IPTQueryResult

QueryPopularCardsByBranch

IPTQueryResult QueryPopularCardsByBranch(int nFolderID,
                                         int lSkipRows,
                                         int lMaxRows,
                                         int lPropIDMask,
                                         java.lang.Object[][] vQueryFilter)

Queries for Cards in a Folder branch sorted by popularity

Parameters:

nFolderID - folderID of the Folder branch being queried

lSkipRows - number of cards to skip

lMaxRows - maximum number of Cards to return

lPropIDMask - propertyIDs to return

vQueryFilter - filter to be applied to the query

Returns:

IPTQueryResult

QueryUnpopularCardsByFolder

IPTQueryResult QueryUnpopularCardsByFolder(int nFolderID,
                                           com.plumtree.openfoundation.util.XPDateTime dtNotAccessedSince,
                                           int nPopularityThreshold,
                                           int lSkipRows,
                                           int lMaxRows,
                                           int lPropIDMask,
                                           java.lang.Object[][] vQueryFilter)

Returns the least popular Cards in a Folder that have either not been accessed since a given date or have a popularity lower than a given threshhold.

Parameters:

nFolderID - folderID of the Folder being queried

dtNotAccessedSince - date since Cards to return have not been accessed

nPopularityThreshold - highest popularity threshold of Cards to return

lSkipRows - number of cards to skip

lMaxRows - maximum number of Cards to return

lPropIDMask - propertyIDs to return

vQueryFilter - filter to be applied to the query

Returns:

IPTQueryResult

QueryUnpopularCardsByBranch

IPTQueryResult QueryUnpopularCardsByBranch(int nFolderID,
                                           com.plumtree.openfoundation.util.XPDateTime dtNotAccessedSince,
                                           int nPopularityThreshold,
                                           int lSkipRows,
                                           int lMaxRows,
                                           int lPropIDMask,
                                           java.lang.Object[][] vQueryFilter)

Returns the least popular Cards in a Folder branch that have either not been accessed since a given date or have a popularity lower than a given threshhold.

Parameters:

nFolderID - folderID of the Folder branch being queried

dtNotAccessedSince - date since Cards to return have not been accessed

nPopularityThreshold - highest popularity threshold of Cards to return

lSkipRows - number of cards to skip

lMaxRows - maximum number of Cards to return

lPropIDMask - propertyIDs to return

vQueryFilter - filter to be applied to the query

Returns:

IPTQueryResult

QueryMostPopularContent

IPTQueryResult QueryMostPopularContent(int nClassID,
                                       int nCount)

Queries user MyPages for popular content.

Parameters:

nClassID - specifies the object type that count be selected as content

nCount - maximum number of objects to return. Ex. top 10 or top 20

Returns:

IPTQueryResult containing PT_PROPID_USAGECOUNT, PT_PROPID_OBJECTID, PT_PROPIDS.PT_PROPID_NAME, PT_PROPID_ISLOCALIZED;

QueryLeastPopularContent

IPTQueryResult QueryLeastPopularContent(int nClassID,
                                        int nCount)

Queries user MyPages for least popular content.

Parameters:

nClassID - specifies the object type that count be selected as content

nCount - maximum number of objects to return. Ex. bottom 10 or bottom 20

Returns:

IPTQueryResult containing PT_PROPID_USAGECOUNT, PT_PROPID_OBJECTID, PT_PROPIDS.PT_PROPID_NAME, PT_PROPID_ISLOCALIZED;

QueryMostPopularCommunityContent

IPTQueryResult QueryMostPopularCommunityContent(int nClassID,
                                                int nCount)

Queries communities for popular content.

Parameters:

nClassID - specifies the object type that count be selected as content

nCount - maximum number of objects to return. Ex. top 10 or top 20

Returns:

IPTQueryResult containing PT_PROPID_USAGECOUNT, PT_PROPID_OBJECTID, PT_PROPIDS.PT_PROPID_NAME, PT_PROPID_ISLOCALIZED;

QueryLeastPopularCommunityContent

IPTQueryResult QueryLeastPopularCommunityContent(int nClassID,
                                                 int nCount)

Queries communities for least popular content.

Parameters:

nClassID - specifies the object type that count be selected as content

nCount - maximum number of objects to return. Ex. bottom 10 or bottom 20

Returns:

IPTQueryResult containing PT_PROPID_USAGECOUNT, PT_PROPID_OBJECTID, PT_PROPIDS.PT_PROPID_NAME, PT_PROPID_ISLOCALIZED;