Package com.webmethods.portal.mech.webspace

Interface IWebSpaceMechanics

All Superinterfaces:

IComponent, IInitializable, IMechanics, ISystemHandler

public interface IWebSpaceMechanics
extends IMechanics

Class ILinkMechanics

Method Summary

Modifier and Type	Method	Description
IURI	acquireURI(String uri)	Resolves hierarchical link
void	addWebSpace(IThingID userID, IThingID objectID, String alias)	Set object to be a portal root
void	fireWebSpaceAddedEvent(IThingID userID, IThingID webSpace)
void	fireWebSpaceRemovedEvent(IThingID userID, IThingID webSpace)
String	getWebSpaceName(IThingID uri)	Lookup object identified by uri and returns its LinkName.
IListView<IView>	listWebSpaces(IThingID userID)	List all roots
void	removeWebSpace(IThingID userID, IThingID objectID)	Unset object to be a portal root

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Method Details

acquireURI

IURI acquireURI(String uri)
         throws PortalException

Resolves hierarchical link

Parameters:

uri -

Returns:

Throws:

PortalException

getWebSpaceName

String getWebSpaceName(IThingID uri)
                throws PortalException

Lookup object identified by uri and returns its LinkName. LinkName is value of object alias key. LinkName is returned only for object that is set to be portal roots

Parameters:

uri -

Returns:

not null Link Name if object has alias AND object is set to be portal root

Throws:

PortalException

listWebSpaces

IListView<IView> listWebSpaces(IThingID userID)
                        throws PortalException

List all roots

Parameters:

userID -

Returns:

Throws:

PortalException

addWebSpace

void addWebSpace(IThingID userID,
 IThingID objectID,
 String alias)
          throws PortalException

Set object to be a portal root

Parameters:

objectID -

alias -

Throws:

PortalException

removeWebSpace

void removeWebSpace(IThingID userID,
 IThingID objectID)
             throws PortalException

Unset object to be a portal root

Parameters:

objectID -

Throws:

PortalException

fireWebSpaceAddedEvent

void fireWebSpaceAddedEvent(IThingID userID,
 IThingID webSpace)
                     throws PortalException

Throws:

PortalException

fireWebSpaceRemovedEvent

void fireWebSpaceRemovedEvent(IThingID userID,
 IThingID webSpace)
                       throws PortalException

Throws:

PortalException