com.webmethods.portal.mech.clipboard

Interface IClipboardMechanics

All Superinterfaces:

IComponent, IInitializable, IMechanics, ISubscribableMechanics, ISystemHandler, IViewableMechanics

All Known Subinterfaces:

IBasicMechanics, IContainerContentConstraintMechanics, IContainerMechanics, IContentMechanics, IFolderMechanics, ILinkMechanics, ILocalePortletMechanics, IPortalRulesMechanics, IPortletMechanics, IRuleMechanics, IScheduleMechanics, ISkinMechanics, ITaskMechanics, ITaskScheduleMechanics, ITemplateMechanics, ITopicMechanics, IVersionableMechanics, IXTypeMechanics

public interface IClipboardMechanics
extends ISubscribableMechanics

Mechanics for portal resources that can be cut or copied to the clipboard.

Field Summary

Fields inherited from interface com.webmethods.portal.mech.subscription.ISubscribableMechanics

CONTENT_FORMAT_EMAIL, CONTENT_FORMAT_EMAIL_DIGEST, CONTENT_FORMAT_PORTAL_INBOX, CONTENT_FORMAT_PORTAL_INBOX_DIGEST, HEADER_FROM, HEADER_SUBJECT, HEADER_TO

Fields inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

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

Method Summary

Modifier and Type	Method and Description
boolean	canCopyToClipboard(IURI itemId, IThingID userId, IURI containerId, boolean isReference) Returns true if the specified user can copy the specified item.
boolean	canCutToClipboard(IURI itemId, IThingID userId, IURI containerId, boolean isReference) Returns true if the specified user can cut the specified item.
void	checkCopyToClipboard(IURI itemId, IThingID userId, IURI containerId, boolean isReference) Throws a PortalAccessException if the specified user cannot copy the specified item.
void	checkCutToClipboard(IURI itemId, IThingID userId, IURI containerId, boolean isReference) Throws a PortalAccessException if the specified user cannot cut the specified item.
void	copyToClipboard(IClipboard clipboard, IURI itemId, IURI containerID, boolean isReference) Clears the clipboard and adds the item to the clipboard as a copied item.
void	cutToClipboard(IClipboard clipboard, IURI itemId, IURI containerID, boolean isReference) Clears the clipboard and adds the item to the clipboard as a cut item.
IClipboard	getClipboard(IContext context) Retrieves a user's clipboard
String	getClipboardInfo(IContext context) Gets a brief description of the current size
IClipboardItem	newClipboardItem(boolean isReference) Creates a new clipboard item

Methods inherited from interface com.webmethods.portal.mech.subscription.ISubscribableMechanics

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

Methods inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

canView, checkView, createPagingCookie, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, getListPropertyHTML, getListPropertyJS, isEnabled, view, view

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

canCutToClipboard

boolean canCutToClipboard(IURI itemId,
                          IThingID userId,
                          IURI containerId,
                          boolean isReference)
                   throws PortalException

Returns true if the specified user can cut the specified item.

Parameters:

itemId - IURI of item to cut.

userId - IThingID of user who wants to cut the item.

containerId - IURI of container in which the item resides. May be null.

isReference - True if item is a shortcut rather than an object.

Returns:

True if the user can cut the item, False if they can't.

Throws:

PortalException - if the userId is invalid.

checkCutToClipboard

void checkCutToClipboard(IURI itemId,
                         IThingID userId,
                         IURI containerId,
                         boolean isReference)
                  throws PortalException,
                         PortalAccessException

Throws a PortalAccessException if the specified user cannot cut the specified item.

Parameters:

itemId - Item to cut.

userId - User whose access to test.

containerId - Container from which to cut. May be null.

isReference - False if the container is the primary container of the item.

Throws:

PortalAccessException - if the specified user cannot cut the specified item.

PortalException - if an error occurred checking access.

canCopyToClipboard

boolean canCopyToClipboard(IURI itemId,
                           IThingID userId,
                           IURI containerId,
                           boolean isReference)
                    throws PortalException

Returns true if the specified user can copy the specified item.

Parameters:

itemId - IURI of item to copy.

userId - IThingID of user who wants to copy the item.

containerId - IURI of container in which the item resides. May be null.

isReference - True if item is a shortcut rather than an object.

Returns:

True if the user can copy the item, False if they can't.

Throws:

PortalException - if the userId is invalid.

checkCopyToClipboard

void checkCopyToClipboard(IURI itemId,
                          IThingID userId,
                          IURI containerId,
                          boolean isReference)
                   throws PortalException,
                          PortalAccessException

Throws a PortalAccessException if the specified user cannot copy the specified item.

Parameters:

itemId - Item to copy.

userId - User whose access to test.

containerId - Container from which to copy. May be null.

isReference - False if the container is the primary container of the item.

Throws:

PortalAccessException - if the specified user cannot copy the specified item.

PortalException - if an error occurred checking access.

cutToClipboard

void cutToClipboard(IClipboard clipboard,
                    IURI itemId,
                    IURI containerID,
                    boolean isReference)
             throws PortalException

Clears the clipboard and adds the item to the clipboard as a cut item.

Parameters:

clipboard - User's clipboard object.

itemId - Item to cut.

containerID - Container from which to cut. May be null.

isReference - False if the container is the primary container of the item.

Throws:

PortalException - if an error occurred.

copyToClipboard

void copyToClipboard(IClipboard clipboard,
                     IURI itemId,
                     IURI containerID,
                     boolean isReference)
              throws PortalException

Clears the clipboard and adds the item to the clipboard as a copied item.

Parameters:

clipboard - User's clipboard object.

itemId - Item to copy.

containerID - Container from which to copy. May be null.

isReference - False if the container is the primary container of the item.

Throws:

PortalException - if an error occurred.

getClipboard

IClipboard getClipboard(IContext context)
                 throws PortalException

Retrieves a user's clipboard

Parameters:

context -

Returns:

Throws:

PortalException

getClipboardInfo

String getClipboardInfo(IContext context)

Gets a brief description of the current size

Parameters:

context -

newClipboardItem

IClipboardItem newClipboardItem(boolean isReference)
                         throws PortalException

Creates a new clipboard item

Parameters:

isReference -

Returns:

Throws:

PortalException