com.webmethods.portal.mech.clipboard

Interface IClipboard

All Superinterfaces:

Collection<IClipboardItem>, IPooledObject<IClipboardItem>, Iterable<IClipboardItem>, List<IClipboardItem>, Serializable

public interface IClipboard
extends List<IClipboardItem>, Serializable, IPooledObject<IClipboardItem>

User's clipboard object. Stored as part of a user's session, it persists only for the duration of that session. Contains a list of IClipboardItems, each of which represents an item cut or copied to the clipboard.

Method Summary

Modifier and Type	Method and Description
String	getInfo() Gets a brief text description of the clipboard contents, include size.
IClipboardItem	newClipboardItem(IURI itemID, IURI containerID, boolean isReference) Create a new clipboard item.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface com.webmethods.portal.system.pool.IPooledObject

getPool, release, setPool

Method Detail

newClipboardItem

IClipboardItem newClipboardItem(IURI itemID,
                                IURI containerID,
                                boolean isReference)
                         throws PortalException

Create a new clipboard item.

Parameters:

itemID - Id of portal resource new clipboard item represents.

containerID - Id of container from which the item will be cut or copied.

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

Returns:

New clipboard item.

Throws:

PortalException - if the item could not be created.

getInfo

String getInfo()

Gets a brief text description of the clipboard contents, include size.

Returns:

Clipboard info text.