Package com.webmethods.portal.bizPolicy.biz.view

Interface IViewablePolicy

All Superinterfaces:
IBizPolicy, IComponent, IInitializable, ISystemHandler
All Known Subinterfaces:
IBasicPolicy, IContainerPolicy, IContextPolicy, IDirServiceBizPolicy, IGroupBizPolicy, IPortletPolicy, IPrincipalBizPolicy, ISchedulePolicy, ISubscriptionPolicy, ITaskBizPolicy, IUserBizPolicy, IViewableContainerPolicy
public interface IViewablePolicy extends IBizPolicy

Policy used to view (viewable) portal resources.

Policy commands are always invoked with a IContext object. The IContext object contains information about the user on whose behalf the command is invoked, as well as access, event, and workflow states. These states, which can be toggled on and off, are known as traits, and are encapsulated by the ITraits object. By default, all policy commands will check access, fire events, and initiate workflow as appropriate for the command.

  • Method Details

    • view

      IView view(IContext context, IURI itemId) throws BizException
      Returns a view of the specified item.
      Parameters:
      context - Context state information (current user, etc.).
      itemId - Item to view.
      Returns:
      View of the item or null.
      Throws:
      BizException - if command fails because access was denied or a datasource error occured.

    • getIcon

      String getIcon(IContext context, IURI itemId, String type) throws BizException
      Gets the url to the specified type of icon representing this resource.
      Parameters:
      context - Context state information (current user, etc.).
      itemId - Item for which to get the icon.
      type - Icon type (ie 'reference'). Null for default icon.
      Returns:
      Icon url (such as 'http://www.netegrity.com/server/ui/images/icon_basic.gif').
      Throws:
      BizException - if command fails because access was denied or a datasource error occured.

    • getPagingCookie

      @Deprecated IPagingCookie getPagingCookie(IContext context, IURI itemId, String view) throws BizException
      Deprecated.
      use IViewableContainerPolicy.getPagingCookie(IContext, IURI, String) instead
      Returns the paging cookie for the view of the specified item, or null if none exsits.
      Parameters:
      context - Context state information (current user, etc.).
      itemId - Item for which to get the paging cookie.
      view - Name of the view (ie 'versions'). Null for default view.
      Returns:
      Paging cookie or null.
      Throws:
      BizException - if command fails because access was denied or a datasource error occured.

    • getPagingCookie

      @Deprecated IPagingCookie getPagingCookie(IContext context, IURI itemId, String view, int start, int pageSize, String sort, String order, boolean reset) throws BizException
      Deprecated.
      use IViewableContainerPolicy.getPagingCookie(IContext, IURI, String, int, int, String, String, boolean) instead
      Returns the paging cookie for the view of the specified item, initialized with the specified default values, or null if none exsits.
      Parameters:
      context - Context state information (current user, etc.).
      itemId - Item for which to get the paging cookie.
      view - Name of the view (ie 'versions'). Null for default view.
      start - Default starting index. The first index is one, not zero.
      pageSize - Default items per page. If zero, will default to the user's preferred page size.
      sort - Default sort key (ie 'name').
      order - Default sort order. Either IPagingCookie.ASCENDING or IPagingCookie.DESCENDING.
      reset - True to always acquire a new paging cookie.
      Returns:
      Paging cookie. If a new paging cookie was created, it will be initialized with the specified default values.
      Throws:
      BizException - if command fails because access was denied or a datasource error occured.

    • setPagingCookie

      @Deprecated void setPagingCookie(IContext context, IURI itemId, String view, int start, int pageSize, String sort, String order) throws BizException
      Deprecated.
      use IViewableContainerPolicy.setPagingCookie(IContext, IURI, String, int, int, String, String) instead
      Sets the modifiable properties of the paging cookie for the specified item.
      Parameters:
      context - Context state information (current user, etc.).
      itemId - Item to for which to set the paging cookie.
      view - Name of the view (ie 'versions'). Null for default view.
      start - New starting index. The first index is one, not zero.
      pageSize - New page size. If zero, will default to the user's preferred page size.
      sort - New sort key (ie 'name').
      order - New sort order. Either IPagingCookie.ASCENDING or IPagingCookie.DESCENDING.
      Throws:
      BizException - if command fails because access was denied or a datasource error occured.

    • pageBackward

      @Deprecated void pageBackward(IContext context, IURI itemId, String view) throws BizException
      Deprecated.
      use IViewableContainerPolicy.pageBackward(IContext, IURI, String) instead
      Pages backward the cookie for the view of the item.
      Parameters:
      context - Context state information (current user, etc.).
      itemId - Item for which to page the paging cookie.
      view - Name of the view (ie 'versions'). Null for default view.
      Throws:
      BizException - if command fails because access was denied or a datasource error occured.

    • pageForeward

      @Deprecated void pageForeward(IContext context, IURI itemId, String view) throws BizException
      Deprecated.
      use IViewableContainerPolicy.pageForeward(IContext, IURI, String) instead
      Pages forward the cookie for the view of the item.
      Parameters:
      context - Context state information (current user, etc.).
      itemId - Item for which to page the paging cookie.
      view - Name of the view (ie 'versions'). Null for default view.
      Throws:
      BizException - if command fails because access was denied or a datasource error occured.