com.sap.netweaver.bc.rf.mi.variant
Interface IVariantManager

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.mi_api.jar]

All Known Subinterfaces:

IMutableVariantManager

public interface IVariantManager

Read-Only interface describing a repository sub manager for variants. Resources may be stored in a repository supporting this sub manager in different variants. A variant of a resource is a specific instance of the resource for a specific frame of context, e.g. in a special language or of a specific MIME type. This interface allows to access the different variants of such "variant-enabled" resources.

Method Summary

boolean	isVariantsEnabled(IResourceHandle resourceHandle) Return true when for the given resource handle multiple variants can be stored.
IResourceHandle	lookupVariant(IRid rid) TBD: Unknown function (concerning selection of the resource, e.g. by special MIME type or special language different from actual user language).
IResourceHandle	lookupVariant(IRid rid, long timestamp) TBD: Unknown function (concerning selection of the resource, e.g. by special MIME type or special language different from actual user language).

Method Detail

isVariantsEnabled

public boolean isVariantsEnabled(IResourceHandle resourceHandle)
                          throws ResourceException

Return true when for the given resource handle multiple variants can be stored.

Parameters:

resourceHandle - resource handle

Returns:

true when for the given resource handle multiple variants can be stored

Throws:

ResourceException - when the resource handle is either invalid or the state can't be determined

lookupVariant

public IResourceHandle lookupVariant(IRid rid)
                              throws ResourceException

TBD: Unknown function (concerning selection of the resource, e.g. by special MIME type or special language different from actual user language). Guess: Look up variant of resource in repository by resource id and the actual resource context.

Parameters:

rid - resource id to be looked up

Returns:

looked up resource variant

Throws:

ResourceException - when the resource id is invalid or this the resource has no variant for the given selection

lookupVariant

public IResourceHandle lookupVariant(IRid rid,
                                     long timestamp)
                              throws ResourceException

TBD: Unknown function (concerning selection of the resource, e.g. by special MIME type or special language different from actual user language). Guess: Look up variant of resource in repository by resource id and the actual resource context. Return only latest matching variant not older in version than the given timestamp.

Parameters:

rid - resource id to be looked up

timestamp - timestamp specifying the upper bound for the returned version

Returns:

looked up resource variant

Throws:

ResourceException - when the resource id is invalid or this the resource has no variant for the given selection matching the given timestamp upper bound