wt.eff.format
Interface EffFormatRetrievalStrategy

All Known Implementing Classes:
PreferenceBasedRetrieval

public interface EffFormatRetrievalStrategy

This interface is designed to encapsulate the various means (algorithms) for the retrieval of effectivity format given some state information, representing a Strategy design pattern.

The various algorithms can differ on how they retrieve the format, for example, by looking at some external resource, or a preference or an attribute on a business object. All that is needed an implementation of this interface and a means to inject this implementation for use by the EffFormatService. See the Customizer's guide on how this wiring can be provided.


Supported API: true

Extendable: true

Since:
Windchill 9.0
See Also:
EffState, EffFormat, EffFormatFactory, EffFormatService

Method Summary
 EffFormatDetails getEffFormatDetails(EffState state)
          Retrieve the format details, given the effectivity state.
 

Method Detail

getEffFormatDetails

EffFormatDetails getEffFormatDetails(EffState state)
Retrieve the format details, given the effectivity state. An implementation can use any means to retrieve the format given the information in the state object.


Supported API: true

Parameters:
state - the current effectivity state.
Returns:
EffFormatDetails