Package com.ptc.wvs.server.util

Class WVSContentHelper

java.lang.Object

com.ptc.wvs.server.util.WVSContentHelper

public class WVSContentHelper
extends Object

This is utility class with helper methods for WVS related operations

Supported API: true

Extendable: false

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WVSContentHelper.IterationType	Enum to represent Iteration type constants e.g.

Method Summary

Modifier and Type	Method	Description
static WTHashSet	findRepresentablesInContainer(WTContainerRef containerRef, WVSContentHelper.IterationType iterationType, Class<? extends Representable>... classes)	This method finds the Representables for given classes in WTContainer of specific iteration type
static Map<Representable,List<Representation>>	getAllRepresentationsWithNoQuickView(WTCollection representables)	Returns representations which do not have QuickView
static Map<Representable,List<Representation>>	getAllRepresentationsWithQuickView(WTCollection representables)	returns all representation of representables only if QuickView already exist on rep
static Iterator<?>	getAncestorContainers(WTContained wtContained)	Get all ancestors for container of wtContained item
static Map<Representable,List<Representation>>	getDefaultRepresentationsWithNoQuickView(WTCollection representables)	returns default representation of representables only if QuickView not exist on rep
static Map<Representable,List<Representation>>	getDefaultRepresentationsWithQuickView(WTCollection representables)	returns default representation of representables only if QuickView already exist on rep
static WTSet	getRepresentablesForQuickView(WTSet set)	This method finds the representables which are eligible for QuickView

Methods inherited from class java.lang.Object

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

Method Details

getDefaultRepresentationsWithQuickView

public static Map<Representable,List<Representation>> getDefaultRepresentationsWithQuickView(WTCollection representables)

returns default representation of representables only if QuickView already exist on rep

Parameters:

representables - for which default representation with QuickView is expected as a return value

Returns:

map of representable to list if default representations list with QuickView

Supported API: true

Extendable: false

getDefaultRepresentationsWithNoQuickView

public static Map<Representable,List<Representation>> getDefaultRepresentationsWithNoQuickView(WTCollection representables)

returns default representation of representables only if QuickView not exist on rep

Parameters:

representables - - collection for Representable for which representations with no QuickView are expected as return value

Returns:

Map of Representable to list of representations with no QuickView

Supported API: true

Extendable: false

getAllRepresentationsWithQuickView

public static Map<Representable,List<Representation>> getAllRepresentationsWithQuickView(WTCollection representables)

returns all representation of representables only if QuickView already exist on rep

Parameters:

representables - - collection of representables for which all representations with QuickView are expected as return value

Returns:

Map of Representable to list of all Representation which have QuickView.

Supported API: true

Extendable: false

getAllRepresentationsWithNoQuickView

public static Map<Representable,List<Representation>> getAllRepresentationsWithNoQuickView(WTCollection representables)

Returns representations which do not have QuickView

Parameters:

representables - - collection of Representable for which all representations with no QuickView are expected as return value

Returns:

map of Representable to list of all representations with no QuickView

Supported API: true

Extendable: false

findRepresentablesInContainer

public static WTHashSet findRepresentablesInContainer(WTContainerRef containerRef,
 WVSContentHelper.IterationType iterationType,
 Class<? extends Representable>... classes)

This method finds the Representables for given classes in WTContainer of specific iteration type

Parameters:

containerRef - in which Representables will be searched.

iterationType - of Representables to be queries

classes - Type of Representables being queried.

Returns:

set containing Representables

Supported API: true

Extendable: false

getRepresentablesForQuickView

public static WTSet getRepresentablesForQuickView(WTSet set)

This method finds the representables which are eligible for QuickView

Parameters:

set - containing Representable that need to be checked for eligible for QuickView or not

Returns:

set containing Representable which are eligible for QuickView

Supported API: true

Extendable: false

getAncestorContainers

public static Iterator<?> getAncestorContainers(WTContained wtContained)
                                         throws WTException

Get all ancestors for container of wtContained item

Parameters:

wtContained - item whose container will be used to find all ancestors

Returns:

Iterator of WTContainer

Throws:

WTException -

Supported API: true

Extendable: false