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

Interface IMutableVariantManager

All Superinterfaces:
IVariantManager

public interface IMutableVariantManager
extends IVariantManager

This interface defines a read-write repository sub-manager for resource variants.

See Also:
IVariantManager

Method Summary
 IResourceHandle createPhysicalResource(IResourceHandle logicalResourceHandle, IResourceCreateDescriptor createDescriptor)
          Creates a new physical resources for the given logical resource and returns its handle.
 void updateInvariantProperties(IResourceHandle logicalResourceHandle, List updateDescriptors)
          Updates the invariant properties of a logical resource.
 void updateInvariantProperty(IResourceHandle logicalResourceHandle, IPropertyUpdateDescriptor propertyUpdateDescriptor)
          Sets or deletes an a invariant property at the logical resource.
 
Methods inherited from interface com.sap.netweaver.bc.rf.mi.variant.IVariantManager
findPhysicalResources, getAllInvariantProperties, getInvariantProperty, getListedInvariantProperties, getLogicalResource, getPhysicalResource, isLogicalResource, isPhysicalResource
 

Method Detail

createPhysicalResource

IResourceHandle createPhysicalResource(IResourceHandle logicalResourceHandle,
                                       IResourceCreateDescriptor createDescriptor)
                                       throws InvalidVariantContextException,
                                              PhysicalResourceAlreadyExistsException,
                                              OperationNotSupportedException,
                                              ResourceException
Creates a new physical resources for the given logical resource and returns its handle. If the given property map contains a set of context properties and values which are not unique (already in use by an existing physical resource) a PhysicalResourceAlreadyExistsException must be thrown.

Parameters:
logicalResourceHandle - A handle of a logical resource.
createDescriptor - Descriptor containing the resource content and properties. The property map must contain all context properties required by the repository. Whether it is required to specify all context properties or not depends on the repository implementation. The descriptor will never be a ICollectionCreateDescriptor or a ILinkCreateDescriptor because only the properties of a resource can vary (not the children or the link target).
Returns:
the handle describing the new resource - must not be null.
Throws:
PhysicalResourceAlreadyExistsException - If a physical resource with the specified context property values already exists.
InvalidVariantContextException - The context properties contained in the property map are invalid.
OperationNotSupportedException
ResourceException

updateInvariantProperty

void updateInvariantProperty(IResourceHandle logicalResourceHandle,
                             IPropertyUpdateDescriptor propertyUpdateDescriptor)
                             throws ResourceException
Sets or deletes an a invariant property at the logical resource.

Parameters:
logicalResourceHandle - The handle of a logical resource.
propertUpdateDescriptor - The property update descriptor
Throws:
ResourceException

updateInvariantProperties

void updateInvariantProperties(IResourceHandle logicalResourceHandle,
                               List updateDescriptors)
                               throws ResourceException
Updates the invariant properties of a logical resource.

Parameters:
logicalResourceHandle -
updateDescriptors - A list containing IPropertyUpdateDescriptor instances.
Throws:
ResourceException
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] KMC-WPC [sap.com] tc/kmc/wpc/wpcfacade api EP-PIN-WPC-WCM
[sap.com] KMC-CM [sap.com] tc/km/frwk api EP-KM-CM


Copyright 2011 SAP AG Complete Copyright Notice