Package wt.part.alternaterep.service

Interface WTPartAlternateRepService

All Known Implementing Classes:

StandardWTPartAlternateRepService

@RemoteInterface
public interface WTPartAlternateRepService

This service interface defines the API for managing WTPartAlternateReps.

• Cookie: None
• Helper: None
• How to use: ServiceFactory.getService(WTPartAlternateRepService.class)
• Service implementation: StandardWTPartAlternateRepService
• ServiceEvent: None
• ServiceException: None

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
WTPartAlternateRep	createWTPartAlternateRepFromVariantSpec(WTPartAlternateRep alternateRep, VariantSpec variantSpec)	Persists a WTPartAlternateRep derived from a VariantSpec.
WTPartAlternateRep	createWTPartAlternateRepFromVariantSpec(WTPartAlternateRep alternateRep, VariantSpec variantSpec, NavigationCriteria navCriteria)	Persists a WTPartAlternateRep derived from a VariantSpec.
QueryResult	getRelatedPARFromVariantSpec(VariantSpec variantSpec)	Retrieve all the configuration context referencing given variant spec Supported API: true
NavigationUnit[]	navigateAlternateRep(WTPartAlternateRep alternateRep)	Returns a collection of NavigationUnit for the alternate rep.

Method Details

createWTPartAlternateRepFromVariantSpec

WTPartAlternateRep createWTPartAlternateRepFromVariantSpec(WTPartAlternateRep alternateRep,
 VariantSpec variantSpec)
                                                    throws WTException

Persists a WTPartAlternateRep derived from a VariantSpec. This version of the API which does not take in a NavigationCriteria only supports VariantSpecs that are Standalone or Organized. The NavigationCriteria will be looked up directly from the VariantSpec and modified before being copied and persisted for the WTPartAlternateRep.

Supported API: true

Parameters:

alternateRep -

variantSpec -

Returns:

Throws:

WTException

createWTPartAlternateRepFromVariantSpec

WTPartAlternateRep createWTPartAlternateRepFromVariantSpec(WTPartAlternateRep alternateRep,
 VariantSpec variantSpec,
 NavigationCriteria navCriteria)
                                                    throws WTException

Persists a WTPartAlternateRep derived from a VariantSpec. This version of the API supports all 3 kinds of VariantSpecs (Standalone/Organized/Managed) as it will use whatever NavigationCriteria is passed in. For Managed VariantSpecs it is expected that this NavigationCriteria was derived from the navigation criteria cache if possible. The NavigationCriteria will be modified before being copied and persisted for the WTPartAlternateRep.

Supported API: true

Parameters:

alternateRep -

variantSpec -

navCriteria -

Returns:

Throws:

WTException

navigateAlternateRep

NavigationUnit[] navigateAlternateRep(WTPartAlternateRep alternateRep)
                               throws WTException

Returns a collection of NavigationUnit for the alternate rep. Each NavUnit will contain one or more PathOccurrences, filtered appropriately.

Supported API: true

Parameters:

alternateRep - The alternate rep whose links are requested.

Returns:

A collection of NavigationUnit that contain one or more PathOccurrences, filtered appropriately.

Throws:

WTException

getRelatedPARFromVariantSpec

QueryResult getRelatedPARFromVariantSpec(VariantSpec variantSpec)
                                  throws WTException

Retrieve all the configuration context referencing given variant spec

Supported API: true

Parameters:

variantSpec -

Returns:

QueryResult

Throws:

WTException