public interface IPortletMechanics extends IBasicMechanics
IThingIDBase.getTypeID()
equal to
IThingType.PORTLET
.PROP_CUSTOM_FILE_ENCODING, PROP_FILE_ENCODING, TITLEBAR_ACTION_SHOW_ADD_TO_HOME, TITLEBAR_ACTION_SHOW_DISPLAY_OPTIONS, TITLEBAR_ACTION_SHOW_MAXIMIZED, TITLEBAR_ACTION_SHOW_MINIMIZED, TITLEBAR_ACTION_SHOW_NORMAL
CONTENT_FORMAT_EMAIL, CONTENT_FORMAT_EMAIL_DIGEST, CONTENT_FORMAT_PORTAL_INBOX, CONTENT_FORMAT_PORTAL_INBOX_DIGEST, HEADER_FROM, HEADER_SUBJECT, HEADER_TO
COMMENTS_LINK_TYPE, CONTENT_LINK_TYPE, DEFAULT_ORDER, DEFAULT_PAGE_SIZE, DEFAULT_SORT, DETAILS_LINK_TYPE, LARGE_ICON_TYPE, LINK_TYPE, LINK_TYPE_COMMENTS, LINK_TYPE_CONTENT, LINK_TYPE_DETAILS, LINK_TYPE_EDIT, LINK_TYPE_HELP, LINK_TYPE_HELP_MAXIMIZED, LINK_TYPE_MAXIMIZED, LINK_TYPE_MINIMIZED, LINK_TYPE_PERMISSIONS, LINK_TYPE_PORTAL_CONTENT, LINK_TYPE_PORTLET_STANDALONE, LINK_TYPE_PROPERTIES, LINK_TYPE_RESTORED, LINK_TYPE_SUBSCRIPTIONS, LINK_TYPE_THUMBNAILS, LINK_TYPE_VERSIONS, PERMISSIONS_LINK_TYPE, PORTAL_CONTENT_LINK_TYPE, PROPERTIES_LINK_TYPE, PROPERTY_LINK_TARGET, PROPERTY_OWNER_NAME, PROPERTY_PARENT_NAME, PROPERTY_TOOLTIP, REFERENCE_ICON_TYPE, SUBSCRIPTIONS_LINK_TYPE, THUMBNAIL_ICON_TYPE, THUMBNAILS_LINK_TYPE, VERSIONS_LINK_TYPE
ACCESS_DENIED, ACCESS_GRANTED, ACCESS_RIGHT_ID, ACCESS_RIGHT_LONG_NAME, ACCESS_RIGHT_SHORT_NAME, ACCESS_RIGHTS_CONTAINER, ACCESS_UNSPECIFIED, AUTH_LEVEL_ANONYMOUS, AUTH_LEVEL_BASIC, AUTH_LEVEL_DEFAULT, AUTH_LEVEL_FULL_ACCESS, AUTH_LEVEL_KERBEROS, AUTH_LEVEL_NTLM, AUTH_LEVEL_PROPERTY
Modifier and Type | Method and Description |
---|---|
boolean |
canUpdateUserProperties(IThingID itemID,
IThingID userID)
Returns whether a given user has permissions to modify user type portlet properties.
|
Object |
executePortletMethod(IPortletBean portletBean,
IContext context,
String method)
Executes portlet method on a given portletBean.
|
void |
fireExecuteMethodEvent(IThingID itemId,
IThingID userId,
String method,
int status)
Fires an event when portlet method is executed.
|
Map<String,WiredProperty> |
getAllWiredProperties(IContext context,
IPortletBean portletBean)
Returns a map of all the portlet properties that contain wiring information.
|
String |
getPortletApplicationName(IURI portletUri)
Returns portlet application name.
|
IPortletBean |
getPortletBean(IURI portletUri,
IThingID userID)
Returns initialized
IPortletBean instance for the given portletUri and userID. |
Reader |
getPortletContent(IPortletBean portletBean,
IContext context)
Takes portletBean instance and executes
IContentProvider.getContent()
method. |
IPortletController |
getPortletController(IContext context,
IURI portletUri)
Returns existing or creates new portlet controller bean
|
IPortletInfo |
getPortletInfo(IURI portletUri)
Returns
IPortletInfo for this portlet |
String |
getPortletName(IURI portletUri)
Returns portlet name within portlet application.
|
WiredProperty |
getWiredProperty(IContext context,
IPortletBean portletBean,
String name)
Returns the wiring information portlet property value.
|
String |
makePortletTypeName(String portletAppName,
String portletName)
Makes composite portlet type name out of portlet application name and portlet name
|
void |
resolveWiring(IContext context,
IPortletBean portletBean)
Resolves all the wiring properties for the portlet.
|
void |
resolveWiring(IContext context,
IPortletBean portletBean,
PortletHelper portletHelper,
PortletData portletData,
List<PortletData> circularWiringStack)
Resolves all the wiring properties for the portlet.
|
addNote, addReference, addRelation, canAddNote, canCloneRemote, canCreate, canDelete, canDestroy, canDoTitlebarAction, canListAccess, canListContainers, canListNotes, canRemoveAccess, canRemoveNote, canSetAccess, canSetAuthentication, canSetOwner, canUninstall, canUpdateContent, canUpdateProperties, canVerb, canViewAuthentication, canViewContent, checkAddNote, checkCloneRemote, checkCreate, checkDelete, checkDestroy, checkListAccess, checkListContainers, checkListNotes, checkRemoveAccess, checkRemoveNote, checkSetAccess, checkSetAuthentication, checkSetOwner, checkUninstall, checkUpdateContent, checkUpdateProperties, checkViewAuthentication, checkViewContent, cloneRemote, copy, create, create, delete, destroy, doAfterInstall, doAfterUpgrade, doBeforeUninstall, doBeforeUpgrade, fireAddNoteEvent, fireCacheInvalidateEvent, fireDeleteEvent, fireInsoEvent, fireListAccessEvent, fireListContainersEvent, fireListNotesEvent, firePurgeEvent, fireRemoveAcccesEvent, fireRemoveNoteEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireUpdateContentEvent, fireUpdatePropertiesEvent, fireViewAuthenticationEvent, fireViewContentEvent, getAccess, getAncestors, getAuthentication, getContent, getContent, getContentStore, getContentStore, getDependencyList, getPrimaryRelatedChild, getPrimaryRelatedContainer, getTimeToLive, isAnonymous, isBaseType, isContainer, isNormal, isReference, isVersionable, isWorkflowEnabled, listAccess, listAccess, listContainers, listContainers, listDependants, listNotes, listRelatedChildren, listRelatedContainers, move, move, prepareForDeletion, removeNote, removeReference, removeRelation, restoreXTypeConfProps, saveXTypeConfProps, setAuthentication, setOwner, setTimeToLive, undeleteAllUndestroyed, updateContent, updateContent, updateProperties, updateProperties
canCopyToClipboard, canCutToClipboard, checkCopyToClipboard, checkCutToClipboard, copyToClipboard, cutToClipboard, getClipboard, getClipboardInfo, newClipboardItem
canDeliverToPrincipal, canEditSubscription, canListSubscriptions, canViewSubscription, checkEditSubscription, checkListSubscriptions, checkViewSubscription, checkViewSubscription, createAppCriteria, createAppCriteriaFolder, createPortletSubscription, createPortletSubscription, disable, disable, disableBySystem, disableBySystem, enable, enable, fireGetAppCriteriaEvent, fireGetSubscriptionEvent, fireSetSubscriptionEvent, fireUnsubscribeEvent, fireViewSubscriptionEvent, generateNotificationContent, generateNotificationHeaders, getAppCriteria, getGroupSubscription, getSubscription, listSubscriptions, listSubscriptions, setGroupSubscription, setGroupSubscription, setSubscription, setSubscription, unsubscribe, unsubscribe, viewSubscription
canView, checkView, createPagingCookie, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, getListPropertyHTML, getListPropertyJS, isEnabled, view, view
getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider
init, shutdown
canRemoveSecurityRealm, canSetSecurityRealm, checkAccess, checkAccessEx, checkRemoveSecurityRealm, checkSetSecurityRealm, cloneAces, fireRemoveAcccesEvent, fireRemoveSecurityRealmEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireSetSecurityRealmEvent, getAccessEx, getAccessList, getAccessListEx, getAclView, getAuthLevelForAuthScheme, getAuthScheme, getAuthSchemeForAuthLevel, getAuthSchemeForResource, getAvailableAuthSchemes, getDefaultAuthScheme, getRightNameForValue, getRightsForType, getRightValueForName, getSecurityRealm, invalidateAcesForThing, invalidateAcesForUser, listSecurityRealmObjects, removeAces, removeSecurityRealm, setAces, setAcesEx, setSecurityRealm, setSecurityRealm
IPortletBean getPortletBean(IURI portletUri, IThingID userID) throws PortalException
IPortletBean
instance for the given portletUri and userID.portletUri
- The portlet instance uri, can be NULL. If NULL then only default properties from the portlet type
configuration are used.userID
- Current user id, can be NULL. If NULL then user type properties are loaded, i.e. defaults from the
portlet type are used.PortalException
IPortletProvider.getPortletBean(com.webmethods.portal.system.IURI, com.webmethods.portal.service.meta2.thing.IThingID)
Reader getPortletContent(IPortletBean portletBean, IContext context) throws PortalException
IContentProvider.getContent()
method. The IContext
is used for setting
IPortletBean.setPortletContext(com.webmethods.portal.bizPolicy.IContext)
.portletBean
- Portlet bean instancecontext
- Current IContext
.Reader
object with the portlet's content, can be NULL, if the content is directly streamed back
to the HTTP client.PortalException
IContentProvider.getContent()
,
IPortletBean.setDirectContentOutputEnabled(boolean)
Object executePortletMethod(IPortletBean portletBean, IContext context, String method) throws PortalException
IPortletMethodInfo
. Default implementation
assumes execution of the method using Java Reflection API.portletBean
- Portlet bean instancecontext
- Current IContext
method
- Name of the method to executePortalException
void fireExecuteMethodEvent(IThingID itemId, IThingID userId, String method, int status) throws PortalException
itemId
- The portlet instance uriuserId
- The current user idmethod
- The portlet method namestatus
- Event status, can be IPortalEvent.STATUS_SUCCESS
or
IPortalEvent.STATUS_ERROR
PortalException
boolean canUpdateUserProperties(IThingID itemID, IThingID userID) throws PortalException
itemID
- Portlet instance thing iduserID
- User thing idPortalException
IPortletPropertyInfo.getType()
,
IPortletPropertyInfo.PROPERTY_TYPE_USER
WiredProperty getWiredProperty(IContext context, IPortletBean portletBean, String name) throws PortalException
portletBean
- Portlet bean instancename
- of the propertyPortalException
IPortletPropertyInfo
Map<String,WiredProperty> getAllWiredProperties(IContext context, IPortletBean portletBean) throws PortalException
portletBean
- Portlet bean instancePortalException
void resolveWiring(IContext context, IPortletBean portletBean) throws PortalException
portletBean
- Portlet bean instancePortalException
void resolveWiring(IContext context, IPortletBean portletBean, PortletHelper portletHelper, PortletData portletData, List<PortletData> circularWiringStack) throws PortalException
portletBean
- Portlet bean instanceportletHelper
- the portlet helper instance for the page, pass null if not rendering a pageportletData
- the portlet data from the page, pass null if not rendering a pagecircularWiringStack
- stack used to detect circular wiring conditionPortalException
String getPortletApplicationName(IURI portletUri) throws PortalException
portletUri
- portlet uriPortalException
String getPortletName(IURI portletUri) throws PortalException
portletUri
- portle uriPortalException
String makePortletTypeName(String portletAppName, String portletName)
portletAppName
- portlet application nameportletName
- portlet nameIPortletController getPortletController(IContext context, IURI portletUri) throws PortalException
context
- current user contextportletUri
- portlet URIPortalException
IPortletInfo getPortletInfo(IURI portletUri) throws PortalException
IPortletInfo
for this portletportletUri
- portlet URIPortalException