com.webmethods.portal.mech.view

Interface IViewableMechanics

All Superinterfaces:

IComponent, IInitializable, IMechanics, ISystemHandler

All Known Subinterfaces:

IBasicMechanics, IClipboardMechanics, IContainerContentConstraintMechanics, IContainerMechanics, IContentMechanics, IContextMechanics, IDirServiceMechanics, IDirSystemMechanics, IFolderMechanics, IGroupMechanics, ILinkMechanics, ILocalePortletMechanics, IPortalRulesMechanics, IPortletMechanics, IPrincipalAttributeMechanics, IPrincipalMechanics, IRoleMechanics, IRuleMechanics, IScheduleMechanics, ISecurityServiceMechanics, ISkinMechanics, ISubscribableMechanics, ITaskMechanics, ITaskScheduleMechanics, ITemplateMechanics, ITopicMechanics, IUserMechanics, IVersionableMechanics, IViewableContainerMechanics, IXTypeMechanics

public interface IViewableMechanics
extends IMechanics

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMENTS_LINK_TYPE Deprecated. use #LINK_TYPE_COMMENTS
static String	CONTENT_LINK_TYPE Deprecated. use #LINK_TYPE_CONTENT
static String	DEFAULT_ORDER Default display order.
static int	DEFAULT_PAGE_SIZE Default page size.
static String	DEFAULT_SORT Default sort key.
static String	DETAILS_LINK_TYPE Deprecated. use #LINK_TYPE_DETAILS
static String	LARGE_ICON_TYPE Large icon type.
static String	LINK_TYPE
static String	LINK_TYPE_COMMENTS Comments/notes about item.
static String	LINK_TYPE_CONTENT External content (external website -- http://www.google.com/ -- or external application -- document.pdf).
static String	LINK_TYPE_DETAILS Extra/advanced details (ex: details folder listing).
static String	LINK_TYPE_EDIT Item's editable custom properties (ex: edit portal page).
static String	LINK_TYPE_HELP Item-specific help.
static String	LINK_TYPE_HELP_MAXIMIZED Item-specific help in a maximized state
static String	LINK_TYPE_MAXIMIZED Maximized view of item.
static String	LINK_TYPE_MINIMIZED Minimized (aka collapsed) view of item.
static String	LINK_TYPE_PERMISSIONS Item's permissions settings.
static String	LINK_TYPE_PORTAL_CONTENT Inline portal content: content rendered within portal page.
static String	LINK_TYPE_PORTLET_STANDALONE Standalone view of the portlet
static String	LINK_TYPE_PROPERTIES Item's portal metadata.
static String	LINK_TYPE_RESTORED Restored (aka normal or expanded) view of item.
static String	LINK_TYPE_SUBSCRIPTIONS Subscriptions to item.
static String	LINK_TYPE_THUMBNAILS Thumbnail(s) of content.
static String	LINK_TYPE_VERSIONS Item's version history.
static String	PERMISSIONS_LINK_TYPE Deprecated. use #LINK_TYPE_PERMISSIONS
static String	PORTAL_CONTENT_LINK_TYPE Deprecated. use #LINK_TYPE_PORTAL_CONTENT
static String	PROPERTIES_LINK_TYPE Deprecated. use #LINK_TYPE_PROPERTIES
static String	PROPERTY_LINK_TARGET Link target property, e.g.
static String	PROPERTY_OWNER_NAME Owner name property of an object
static String	PROPERTY_PARENT_NAME Parent name property of an object
static String	PROPERTY_TOOLTIP Tooltip property ([name]: [description]).
static String	REFERENCE_ICON_TYPE Reference icon type.
static String	SUBSCRIPTIONS_LINK_TYPE Deprecated. use #LINK_TYPE_SUBSCRIPTIONS
static String	THUMBNAIL_ICON_TYPE Thumbnail icon type.
static String	THUMBNAILS_LINK_TYPE Deprecated. use #LINK_TYPE_THUMBNAILS
static String	VERSIONS_LINK_TYPE Deprecated. use #LINK_TYPE_VERSIONS

Method Summary

Modifier and Type	Method and Description
boolean	canView(IURI itemId, IThingID userId, Map<?,?> capabilities) Returns true if the specified user can view the specified item.
void	checkView(IURI itemId, IThingID userId, Map<?,?> capabilities) Throws a PortalAccessException if the specified user cannot view the specified item.
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.
void	fireViewEvent(IURI itemId, IThingID userId, int status) Fires a view properties event.
String	getCss(IURI itemId) Gets the css style content for the specified item.
String	getCss(IURI itemId, String type) Gets the css style content for the specified item.
String	getDefaultLinkType(IURI itemId) Returns the default link type for the specified item.
String	getFormattedProperty(IView view, String property, Map<String,Object> formatInfo) Returns a formatted display for the value of the view's specified property.
String	getHierachicalUri(IURI itemId) Returns natural hierarchical URI for the given item.
String	getIcon(IURI itemId) Gets the web path, relative to the web server root, to the default icon representing this resource.
String	getIcon(IURI itemId, String type) Gets the web path, relative to the web server root, to the specified type of icon representing this resource.
String	getLink(IURI itemId) Gets the web path, relative to the web server root, to the default view of the resource.
String	getLink(IURI itemId, String type) Gets the web path, relative to the web server root, to the specified view of the resource.
String	getListProperty(IView view, String property) Returns a condensed display string, appropriate for a table listing display, representing the value of the view's specified property.
default String	getListPropertyHTML(IView view, String property) Same as getListProperty, but the result is HTML encoded for direct display in browser.
default String	getListPropertyJS(IView view, String property) Same as getListProperty, but the result is JS encoded suitable for use in scripting.
boolean	isEnabled(IView view) True if the specified view represents an active, enabled, and addressable resource.
IView	view(IURI itemId) Returns the standard view of the specified item.
IView	view(IURI itemId, IThingID userId) Returns the view of the specified item, filtered for the specified user.

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

Field Detail

PROPERTY_TOOLTIP

static final String PROPERTY_TOOLTIP

Tooltip property ([name]: [description]).

See Also:

Constant Field Values

PROPERTY_LINK_TARGET

static final String PROPERTY_LINK_TARGET

Link target property, e.g. _self, _parent, _blank

See Also:

Constant Field Values

PROPERTY_OWNER_NAME

static final String PROPERTY_OWNER_NAME

Owner name property of an object

See Also:

Constant Field Values

PROPERTY_PARENT_NAME

static final String PROPERTY_PARENT_NAME

Parent name property of an object

See Also:

Constant Field Values

LINK_TYPE_COMMENTS

static final String LINK_TYPE_COMMENTS

Comments/notes about item.

See Also:

Constant Field Values

LINK_TYPE_CONTENT

static final String LINK_TYPE_CONTENT

External content (external website -- http://www.google.com/ -- or external application -- document.pdf).

See Also:

Constant Field Values

LINK_TYPE_DETAILS

static final String LINK_TYPE_DETAILS

Extra/advanced details (ex: details folder listing).

See Also:

Constant Field Values

LINK_TYPE_EDIT

static final String LINK_TYPE_EDIT

Item's editable custom properties (ex: edit portal page).

See Also:

Constant Field Values

LINK_TYPE_HELP

static final String LINK_TYPE_HELP

Item-specific help.

See Also:

Constant Field Values

LINK_TYPE_HELP_MAXIMIZED

static final String LINK_TYPE_HELP_MAXIMIZED

Item-specific help in a maximized state

See Also:

Constant Field Values

LINK_TYPE_MAXIMIZED

static final String LINK_TYPE_MAXIMIZED

Maximized view of item.

See Also:

Constant Field Values

LINK_TYPE_RESTORED

static final String LINK_TYPE_RESTORED

Restored (aka normal or expanded) view of item.

See Also:

Constant Field Values

LINK_TYPE_MINIMIZED

static final String LINK_TYPE_MINIMIZED

Minimized (aka collapsed) view of item.

See Also:

Constant Field Values

LINK_TYPE_PORTLET_STANDALONE

static final String LINK_TYPE_PORTLET_STANDALONE

Standalone view of the portlet

See Also:

Constant Field Values

LINK_TYPE_PERMISSIONS

static final String LINK_TYPE_PERMISSIONS

Item's permissions settings.

See Also:

Constant Field Values

LINK_TYPE_PORTAL_CONTENT

static final String LINK_TYPE_PORTAL_CONTENT

Inline portal content: content rendered within portal page.

See Also:

Constant Field Values

LINK_TYPE_PROPERTIES

static final String LINK_TYPE_PROPERTIES

Item's portal metadata.

See Also:

Constant Field Values

LINK_TYPE_SUBSCRIPTIONS

static final String LINK_TYPE_SUBSCRIPTIONS

Subscriptions to item.

See Also:

Constant Field Values

LINK_TYPE_THUMBNAILS

static final String LINK_TYPE_THUMBNAILS

Thumbnail(s) of content.

See Also:

Constant Field Values

LINK_TYPE_VERSIONS

static final String LINK_TYPE_VERSIONS

Item's version history.

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE

static final int DEFAULT_PAGE_SIZE

Default page size.

See Also:

Constant Field Values

DEFAULT_SORT

static final String DEFAULT_SORT

Default sort key.

See Also:

Constant Field Values

DEFAULT_ORDER

static final String DEFAULT_ORDER

Default display order.

See Also:

Constant Field Values

REFERENCE_ICON_TYPE

static final String REFERENCE_ICON_TYPE

Reference icon type.

See Also:

Constant Field Values

LARGE_ICON_TYPE

static final String LARGE_ICON_TYPE

Large icon type.

See Also:

Constant Field Values

THUMBNAIL_ICON_TYPE

static final String THUMBNAIL_ICON_TYPE

Thumbnail icon type.

See Also:

Constant Field Values

LINK_TYPE

static final String LINK_TYPE

See Also:

Constant Field Values

CONTENT_LINK_TYPE

@Deprecated
static final String CONTENT_LINK_TYPE

Deprecated. use #LINK_TYPE_CONTENT

See Also:

Constant Field Values

PORTAL_CONTENT_LINK_TYPE

@Deprecated
static final String PORTAL_CONTENT_LINK_TYPE

Deprecated. use #LINK_TYPE_PORTAL_CONTENT

See Also:

Constant Field Values

PROPERTIES_LINK_TYPE

@Deprecated
static final String PROPERTIES_LINK_TYPE

Deprecated. use #LINK_TYPE_PROPERTIES

See Also:

Constant Field Values

PERMISSIONS_LINK_TYPE

@Deprecated
static final String PERMISSIONS_LINK_TYPE

Deprecated. use #LINK_TYPE_PERMISSIONS

See Also:

Constant Field Values

COMMENTS_LINK_TYPE

@Deprecated
static final String COMMENTS_LINK_TYPE

Deprecated. use #LINK_TYPE_COMMENTS

See Also:

Constant Field Values

SUBSCRIPTIONS_LINK_TYPE

@Deprecated
static final String SUBSCRIPTIONS_LINK_TYPE

Deprecated. use #LINK_TYPE_SUBSCRIPTIONS

See Also:

Constant Field Values

VERSIONS_LINK_TYPE

@Deprecated
static final String VERSIONS_LINK_TYPE

Deprecated. use #LINK_TYPE_VERSIONS

See Also:

Constant Field Values

DETAILS_LINK_TYPE

@Deprecated
static final String DETAILS_LINK_TYPE

Deprecated. use #LINK_TYPE_DETAILS

See Also:

Constant Field Values

THUMBNAILS_LINK_TYPE

@Deprecated
static final String THUMBNAILS_LINK_TYPE

Deprecated. use #LINK_TYPE_THUMBNAILS

See Also:

Constant Field Values

Method Detail

canView

boolean canView(IURI itemId,
                IThingID userId,
                Map<?,?> capabilities)
         throws PortalException

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

Parameters:

itemId - IURI of item

userId - IThingID of user

capabilities - Known set of capabilities for this user. May be null, in which case they'll be looked up from the IContext.SCOPE_REQUEST attributes on the user's IContext.

Returns:

True if user can view the item, false if they can't.

Throws:

PortalException - if the userId is invalid.

checkView

void checkView(IURI itemId,
               IThingID userId,
               Map<?,?> capabilities)
        throws PortalException,
               PortalAccessException

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

Parameters:

itemId - Item to view.

userId - User whose access to test.

capabilities - User's capabilities. Null for default.

Throws:

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

PortalException - if an error occurred checking access.

fireViewEvent

void fireViewEvent(IURI itemId,
                   IThingID userId,
                   int status)
            throws PortalException

Fires a view properties event.

Parameters:

itemId - Item whose properties were viewed.

userId - User who viewed the properties.

status - Status of the event (successful, denied, error).

Throws:

PortalException - if an error occurs raising the event.

view

IView view(IURI itemId)
    throws PortalException

Returns the standard view of the specified item.

Parameters:

itemId - Item to view.

Returns:

View of item or null.

Throws:

PortalException - if an error occurs.

view

IView view(IURI itemId,
           IThingID userId)
    throws PortalException

Returns the view of the specified item, filtered for the specified user.

Parameters:

itemId - Item to view.

userId - User for which to filter the view.

Returns:

View of item or null.

Throws:

PortalException - if an error occurs.

getIcon

String getIcon(IURI itemId)
        throws PortalException

Gets the web path, relative to the web server root, to the default icon representing this resource.

Parameters:

itemId - Item for which to get the icon.

Returns:

Icon path (such as '/server/ui/images/icon_basic.gif').

Throws:

PortalException - if an error occurs.

getIcon

String getIcon(IURI itemId,
               String type)
        throws PortalException

Gets the web path, relative to the web server root, to the specified type of icon representing this resource.

Parameters:

itemId - Item for which to get the icon.

type - Icon type (ie 'reference'). Null for default icon.

Returns:

Icon path (such as '/server/ui/images/icon_basic.gif').

Throws:

PortalException - if an error occurs.

getLink

String getLink(IURI itemId)
        throws PortalException

Gets the web path, relative to the web server root, to the default view of the resource.

Parameters:

itemId - Item for which to get the link.

Returns:

Link path (such as '/server/nis/home').

Throws:

PortalException - if an error occurs.

getHierachicalUri

String getHierachicalUri(IURI itemId)
                  throws PortalException

Returns natural hierarchical URI for the given item. May return null if uri may not be produced

Parameters:

itemId -

Returns:

Throws:

PortalException

getLink

String getLink(IURI itemId,
               String type)
        throws PortalException

Gets the web path, relative to the web server root, to the specified view of the resource.

Parameters:

itemId - Item for which to get the link.

type - View type (ie 'content' or 'properties'). Null for default view.

Returns:

Link path (such as '/server/nis/home').

Throws:

PortalException - if an error occurs.

getDefaultLinkType

String getDefaultLinkType(IURI itemId)

Returns the default link type for the specified item. If the default link to the item will return a properties page, the type should be PROPERTIES_LINK_TYPE. If the default link will return return non-portal content (such as a word document or an external web page) the type should be CONTENT_LINK_TYPE.

Parameters:

itemId - Item of interest.

Returns:

Default link type.

getCss

String getCss(IURI itemId)
       throws PortalException

Gets the css style content for the specified item. A sample style follows:

table.random908983274 { padding: 2px; }
 td.random908983274 { color: pink; }

Parameters:

itemId - Item for which to get the css.

Returns:

Css style content.

Throws:

PortalException - if an error occurs.

getCss

String getCss(IURI itemId,
              String type)
       throws PortalException

Gets the css style content for the specified item. A sample style follows:

table.random908983274 { padding: 2px; }
 td.random908983274 { color: pink; }

Parameters:

itemId - Item for which to get the css.

type - Context type (ie 'leftnav'). Null for default css.

Returns:

Css style content.

Throws:

PortalException - if an error occurs.

getListProperty

String getListProperty(IView view,
                       String property)
                throws PortalException

Returns a condensed display string, appropriate for a table listing display, representing the value of the view's specified property.

Parameters:

view - View whose property to get.

property - Property to display.

Returns:

List property text.

Throws:

PortalException - if an error occurs.

getListPropertyJS

default String getListPropertyJS(IView view,
                                 String property)
                          throws PortalException

Same as getListProperty, but the result is JS encoded suitable for use in scripting.

Throws:

PortalException

getListPropertyHTML

default String getListPropertyHTML(IView view,
                                   String property)
                            throws PortalException

Same as getListProperty, but the result is HTML encoded for direct display in browser.

Throws:

PortalException

getFormattedProperty

String getFormattedProperty(IView view,
                            String property,
                            Map<String,Object> formatInfo)
                     throws PortalException

Returns a formatted display for the value of the view's specified property.

Parameters:

view - View whose property to get.

property - Property to display.

formatInfo - Formatting information.

Returns:

Formatted property content.

Throws:

PortalException - if an error occurs.

isEnabled

boolean isEnabled(IView view)
           throws PortalException

True if the specified view represents an active, enabled, and addressable resource.

Parameters:

view - View to test.

Returns:

True if the specified view represents an active, enable, and addressable resource.

Throws:

PortalException - if an error occurs.

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.

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.