com.webmethods.portal.mech.portlet

Interface IPortletProviderMechanics

All Superinterfaces:

IComponent, IInitializable, IMechanics, ISystemHandler

public interface IPortletProviderMechanics
extends IMechanics

Method Summary

Modifier and Type	Method and Description
String	getPortletDesriptors(IThingID userId, IThingID pageId) Deprecated. not a supported operation anymore
IPortletInfo	getPortletInfo(File portletDescriptor, File wmPortletDescriptor) Returns IPortletInfo loaded from the portlet descriptor files (portlet.xml and wm-portlet.xml)
default IPortletInfo	getPortletInfo(InputStream portletDescriptor, InputStream wmPortletDescriptor) Returns IPortletInfo loaded from the portlet descriptor files (portlet.xml and wm-portlet.xml)
IPortletInfo	getPortletInfo(IURI thingUri) Returns IPortletInfo for the porrtlet/dbo uri
IPortletInfo	getPortletInfo(String typeName) Returns IPortletInfo for the portlet/dbo type name
IThingID	getPortletTypeID(String typeName) Return thingID of the portlet default published instance, specified by typeName
String	getPortletTypeName(IURI thingUri) Returns thing (base/xtype/portlet) type name for the given uri
IThingID	getPortletXTypeID(String typeName) Return thingID of the portlet xtype name specified by typeName

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 Detail

getPortletDesriptors

@Deprecated
String getPortletDesriptors(IThingID userId,
                                        IThingID pageId)
                                 throws PortalException

Deprecated. not a supported operation anymore

Returns XML for WSP

Parameters:

userId - current user

pageId - the page id

Returns:

Throws:

PortalException

getPortletTypeName

String getPortletTypeName(IURI thingUri)
                   throws PortalException

Returns thing (base/xtype/portlet) type name for the given uri

Parameters:

thingUri - the uri for the thing

Returns:

name of the assosiated portlet type

Throws:

PortalException

getPortletTypeID

IThingID getPortletTypeID(String typeName)
                   throws PortalException

Return thingID of the portlet default published instance, specified by typeName

Parameters:

typeName - the name of the portlet/dbo type

Returns:

thingID for the portlet xtype

Throws:

PortalException

getPortletXTypeID

IThingID getPortletXTypeID(String typeName)
                    throws PortalException

Return thingID of the portlet xtype name specified by typeName

Parameters:

typeName - the name of the portlet/dbo type

Returns:

thingID for the portlet xtype

Throws:

PortalException

getPortletInfo

IPortletInfo getPortletInfo(String typeName)
                     throws PortalException

Returns IPortletInfo for the portlet/dbo type name

Parameters:

typeName -

Returns:

Throws:

PortalException

getPortletInfo

IPortletInfo getPortletInfo(IURI thingUri)
                     throws PortalException

Returns IPortletInfo for the porrtlet/dbo uri

Parameters:

thingUri -

Returns:

Throws:

PortalException

getPortletInfo

IPortletInfo getPortletInfo(File portletDescriptor,
                            File wmPortletDescriptor)
                     throws PortalException

Returns IPortletInfo loaded from the portlet descriptor files (portlet.xml and wm-portlet.xml)

Parameters:

portletDescriptor - the portlet.xml descriptor file

wmPortletDescriptor - the wm-portlet.xml descriptor file

Returns:

Throws:

PortalException

getPortletInfo

default IPortletInfo getPortletInfo(InputStream portletDescriptor,
                                    InputStream wmPortletDescriptor)
                             throws PortalException

Returns IPortletInfo loaded from the portlet descriptor files (portlet.xml and wm-portlet.xml)

Parameters:

portletDescriptor - the portlet.xml descriptor file

wmPortletDescriptor - the wm-portlet.xml descriptor file

Returns:

Throws:

PortalException