com.sap.netweaver.bc.rf.mi.namespace
Interface IMutableNamespaceManager

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

All Superinterfaces:

INamespaceManager

public interface IMutableNamespaceManager

extends INamespaceManager

Read-And-Write interface describing a repository sub manager for namespace. Namespace means the realm of names the resources fill in the repository. This manager mainly provides means to create resources in the namespace.

Method Summary

java.util.List	copyResource(IResourceHandle resourceHandle, ICopyDescriptor copyDescriptor) Copy resource based on a resource copy descriptor.
IResourceHandle	createResource(ICreateDescriptor createDescriptor) Create a resource based on a descriptor.
java.util.List	deleteResource(IResourceHandle resourceHandle) Deletes the resource.
java.util.List	moveResource(IResourceHandle resourceHandle, IMoveDescriptor moveDescriptor) Move resource based on a resource move descriptor.
void	reorderCollection(IResourceHandle resourceHandle, java.util.List orderPositions) Reorder children of the resource collection.
void	setCollectionOrderMechanism(IResourceHandle resourceHandle, OrderMechanism orderMechanism) Change the OrderMechanism of the collection.
void	setLinkDescriptor(IResourceHandle resourceHandle, ILinkDescriptor linkDescriptor) Changes a link's type and/or target.

Methods inherited from interface com.sap.netweaver.bc.rf.mi.namespace.INamespaceManager

countResources, findResources, findResources, getCollectionOrderMechanism, getLinkDescriptor, getQueryBuilder, isCollection, isLink, isQueryPropertyNameUnderstood

Method Detail

createResource

public IResourceHandle createResource(ICreateDescriptor createDescriptor)
                               throws ResourceException

Create a resource based on a descriptor. Default resource create descriptors reside in the same package as the interface does. A repository may support these and/or others. Note: Descriptors may not be altered and must be fully released when returning from the call due to performance (reuse) reasons.

Parameters:

createDescriptor - create descriptor

Returns:

resource handle of the newly created resource

Throws:

ResourceException - Exception raised in failure situation

deleteResource

public java.util.List deleteResource(IResourceHandle resourceHandle)
                              throws ResourceException,
                                     OperationNotCompletedException

Deletes the resource. If the resource is a collection then all children will be deleted ("deep delete"). This method is not atomic. Although each single delete of a "deep delete" must be atomic. If the resource is versioned it is up to the repositoy implementation to decide whether to delete the complete version history and all revisions or not. Usually the revisions and version history should not be deleted. Note: Descriptors may not be altered and must be fully released when returning from the call due to performance (reuse) reasons.

Parameters:

resourceHandle - resource handle

Returns:

list of resource identifiers (IRid) of all deleted resources

Throws:

OperationNotCompletedException - If the call was successfull but some of the resources could not be deleted (in case of a "deep delete"). Possible reasons are: resource is locked, user does not have delete permission, etc.

ResourceException - Exception raised in failure situation

copyResource

public java.util.List copyResource(IResourceHandle resourceHandle,
                                   ICopyDescriptor copyDescriptor)
                            throws ResourceException,
                                   OperationNotCompletedException

Copy resource based on a resource copy descriptor. Default resource copy descriptors reside in the same package as the interface does. A repository may supports these and/or others. The first returned resource handle must be the copied root resource handle, if this operation succeeded at all.

Note: This method needs not to be handled atomically! Although this operation may fail in parts, the operation on one of the many operands provided through the parameter list is always expected to be atomic! Note: Descriptors may not be altered and must be fully released when returning from the call due to performance (reuse) reasons.

Parameters:

resourceHandle - resource handle

copyDescriptor - copy descriptor

Returns:

list of new resource identifiers (IRid) of all copied resources

Throws:

OperationNotCompletedException - when the call was successfull but some of the resources could not be copied (in case of a "deep copy"); possible reasons are, that the target collection is locked, the user does not have create permission, etc.; child resource identifiers are not reported

ResourceException - Exception raised in failure situation

moveResource

public java.util.List moveResource(IResourceHandle resourceHandle,
                                   IMoveDescriptor moveDescriptor)
                            throws ResourceException,
                                   OperationNotCompletedException

Move resource based on a resource move descriptor. Default resource move descriptors reside in the same package as the interface does. A repository may support these and/or others. The first returned resource handle must be the moved root resource handle, if this operation succeeded at all.

Note: This method needs not to be handled atomically! Although this operation may fail in parts, the operation on one of the many operands provided through the parameter list is always expected to be atomic! Note: Descriptors may not be altered and must be fully released when returning from the call due to performance (reuse) reasons.

Parameters:

resourceHandle - resource handle

moveDescriptor - move descriptor

Returns:

list of all moved resources; resources failed to be moved either of repository-internal reasons, follow-up reasons or others are stored with their respective exception inside the list

Throws:

OperationNotCompletedException - If the call was successfull but some of the resources could not be moved (in case of a "deep copy"). Possible reasons are: target collection is locked, user does not have create permission, etc.

ResourceException - Exception raised in failure situation

setCollectionOrderMechanism

public void setCollectionOrderMechanism(IResourceHandle resourceHandle,
                                        OrderMechanism orderMechanism)
                                 throws ResourceException

Change the OrderMechanism of the collection.

Parameters:

resourceHandle - resource handle of the collection

orderMechanism - order mechanism of the collection

Throws:

ResourceException - Exception raised in failure situation

reorderCollection

public void reorderCollection(IResourceHandle resourceHandle,
                              java.util.List orderPositions)
                       throws ResourceException

Reorder children of the resource collection. The children of the resource collection will be rearranged according to the given list of OrderPositions for the children of the given resource collection.

Parameters:

resourceHandle - resource handle of the collection

orderPositions - list of OrderPosition s for the children of the given resource collection

Throws:

ResourceException - Exception raised in failure situation

setLinkDescriptor

public void setLinkDescriptor(IResourceHandle resourceHandle,
                              ILinkDescriptor linkDescriptor)
                       throws ResourceException

Changes a link's type and/or target. Note: Descriptors may not be altered and must be fully released when returning from the call due to performance (reuse) reasons.

Parameters:

resourceHandle - resource handle of the link

linkDescriptor - link descriptor of the link

Throws:

ResourceException - Exception raised in failure situation