com.sapportals.wcm.repository
Interface IExtendedCollection

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

public interface IExtendedCollection

Extended interface for collections, providing
- extended link creation methods.
- workspace support methods.

* Copyright (c) SAP AG 2002-2004

Method Summary

IResource	createExternalLink(java.lang.String name, IUri absoluteTargetUri, boolean isPermanent, IPosition position, IPropertyMap properties, boolean ignorePropertyFailures) Creates an external link, compatible to LinkType.EXTERNAL
IResource	createInternalDynamicLink(java.lang.String name, RID targetRid, IPosition position, IPropertyMap properties, boolean ignorePropertyFailures) Creates an internal link that automatically follows the target resource and disappears when the link target disappears.
IResource	createInternalStaticLink(java.lang.String name, RID targetRid, boolean isPermanent, IPosition position, IPropertyMap properties, boolean ignorePropertyFailures) Creates an internal link, compatible to LinkType.INTERNAL
IResource	createVersionControlledResource(RID baseRevisionRid, java.lang.String name, IPosition position) If called on a workspace controlled collection, a new version controlled resource based on the given revision is created
ICollection	createWorkspace(java.lang.String name, IPosition position) Creates a new workspace resource.
IResourceList	getChildren(java.lang.Boolean visible, java.lang.Boolean collections, java.lang.Boolean links) Returns a filtered list of the resources in this collection.

Method Detail

createExternalLink

public IResource createExternalLink(java.lang.String name,
                                    IUri absoluteTargetUri,
                                    boolean isPermanent,
                                    IPosition position,
                                    IPropertyMap properties,
                                    boolean ignorePropertyFailures)
                             throws ResourceException

Creates an external link, compatible to LinkType.EXTERNAL

Parameters:

name - member name in collection

isPermanent - whether the redirection is temporary (continue using the RID of the link) or permanent (use of the RID of the link discouraged)

position - position where to create the link (or null when unspecified)

properties - initial property map for link resource

ignorePropertyFailures - set to true to ignore errors while initializing the property map

absoluteTargetUri - TBD: Description of the incoming method parameter

Returns:

link resource

Throws:

ResourceException - Exception raised in failure situation

createInternalDynamicLink

public IResource createInternalDynamicLink(java.lang.String name,
                                           RID targetRid,
                                           IPosition position,
                                           IPropertyMap properties,
                                           boolean ignorePropertyFailures)
                                    throws ResourceException

Creates an internal link that automatically follows the target resource and disappears when the link target disappears. Note that this type of link can only be created when the link target already exists.

Note that a relative RID will be resolved upon creation of the link resource.

Parameters:

name - member name in collection

targetRid - link target

position - position where to create the link (or null when unspecified)

properties - initial property map for link resource

ignorePropertyFailures - set to true to ignore errors while initializing the property map

Returns:

link resource

Throws:

ResourceException - Exception raised in failure situation

createInternalStaticLink

public IResource createInternalStaticLink(java.lang.String name,
                                          RID targetRid,
                                          boolean isPermanent,
                                          IPosition position,
                                          IPropertyMap properties,
                                          boolean ignorePropertyFailures)
                                   throws ResourceException

Creates an internal link, compatible to LinkType.INTERNAL

Parameters:

name - member name in collection

isPermanent - whether the redirection is temporary (continue using the RID of the link) or permanent (use of the RID of the link discouraged)

position - position where to create the link (or null when unspecified)

properties - initial property map for link resource

ignorePropertyFailures - set to true to ignore errors while initializing the property map

targetRid - TBD: Description of the incoming method parameter

Returns:

link resource

Throws:

ResourceException - Exception raised in failure situation

createWorkspace

public ICollection createWorkspace(java.lang.String name,
                                   IPosition position)
                            throws ResourceException,
                                   NotSupportedException

Creates a new workspace resource.

Parameters:

name - member name in collection

position - position where to create the link (or null when unspecified)

Returns:

workspace resource

Throws:

ResourceException - Exception raised in failure situation

NotSupportedException - if called on a resource that is not a workspace collection

createVersionControlledResource

public IResource createVersionControlledResource(RID baseRevisionRid,
                                                 java.lang.String name,
                                                 IPosition position)
                                          throws ResourceException,
                                                 NotSupportedException

If called on a workspace controlled collection, a new version controlled resource based on the given revision is created

Parameters:

baseRevisionRid - the rid of the new vcr's base revision

name - member name in collection

position - position where to create the vcr (or null when unspecified)

Returns:

version controlled resource

Throws:

ResourceException - Exception raised in failure situation

NotSupportedException - if called on a resource that is not a sibling of a workspace resource
- if the resource identified by baseRevisionRid doesn't exist or is no version resource

getChildren

public IResourceList getChildren(java.lang.Boolean visible,
                                 java.lang.Boolean collections,
                                 java.lang.Boolean links)
                          throws ResourceException,
                                 AccessDeniedException

Returns a filtered list of the resources in this collection.

Parameters:

visible - true: only visible resource (system property "hidden" is false), false: only hidden resources, null: not relevant

collections - true: only collections, false: only resources which are not collections, null: note relevant

links - true: only links, false: only non-link resources, null: not relevant

Returns:

A list of resources

Throws:

ResourceException -

AccessDeniedException - If the resource is locked, readonly or authorization failed