com.webmethods.portal.mech.view

Interface IViewableContainerMechanics

All Superinterfaces:

IComponent, IInitializable, IMechanics, ISystemHandler, IViewableMechanics

All Known Subinterfaces:

IContainerMechanics, IDirServiceMechanics, IFolderMechanics, IGroupMechanics, IPrincipalMechanics, IRoleMechanics, IScheduleMechanics, ITemplateMechanics, ITopicMechanics, IUserMechanics

public interface IViewableContainerMechanics
extends IViewableMechanics

Mechanics for a viewable resource. All viewable resources have at least one IView associated with them.

Field Summary

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
IPagingCookie	createPagingCookie(IURI itemId, IThingID userId, String view, int start, int pageSize, String sort, String order) Returns a new paging cookie for a list view of the specified resource, initialized with the specified default values, or null if the resource cannot produce a paging cookie.

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

canView, checkView, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, 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

createPagingCookie

IPagingCookie createPagingCookie(IURI itemId,
                                 IThingID userId,
                                 String view,
                                 int start,
                                 int pageSize,
                                 String sort,
                                 String order)
                          throws PortalException

Returns a new paging cookie for a list view of the specified resource, initialized with the specified default values, or null if the resource cannot produce a paging cookie.

Specified by:

createPagingCookie in interface IViewableMechanics

Parameters:

itemId - Resource for which to get the paging cookie.

userId - User for which to get the paging cookie.

view - Name of the view (ie 'versions'). Null for default view.

start - Default starting index.

pageSize - Default items per page.

sort - Default sort key.

order - Default sort order.

Returns:

Paging cookie or null.

Throws:

PortalException - if an error occurs.