Package com.webmethods.portal.mech.storage

Interface ITemplateMechanics

All Superinterfaces:

IAccessMechanics, IBasicMechanics, IClipboardMechanics, IComponent, IContainerMechanics, IInitializable, IMechanics, ISubscribableMechanics, ISystemHandler, IVersionableMechanics, IViewableContainerMechanics, IViewableMechanics

public interface ITemplateMechanics
extends IContainerMechanics

Mechanics to manage templates objects

Field Summary

Fields inherited from interface com.webmethods.portal.mech.access.IAccessMechanics

ACCESS_DENIED, ACCESS_GRANTED, ACCESS_RIGHT_ID, ACCESS_RIGHT_LONG_NAME, ACCESS_RIGHT_SHORT_NAME, ACCESS_RIGHTS_CONTAINER, ACCESS_UNSPECIFIED, AUTH_LEVEL_ANONYMOUS, AUTH_LEVEL_BASIC, AUTH_LEVEL_DEFAULT, AUTH_LEVEL_FULL_ACCESS, AUTH_LEVEL_KERBEROS, AUTH_LEVEL_NTLM, AUTH_LEVEL_PROPERTY

Fields inherited from interface com.webmethods.portal.mech.storage.IBasicMechanics

PROP_CUSTOM_FILE_ENCODING, PROP_FILE_ENCODING, TITLEBAR_ACTION_SHOW_ADD_TO_HOME, TITLEBAR_ACTION_SHOW_DISPLAY_OPTIONS, TITLEBAR_ACTION_SHOW_MAXIMIZED, TITLEBAR_ACTION_SHOW_MINIMIZED, TITLEBAR_ACTION_SHOW_NORMAL

Fields inherited from interface com.webmethods.portal.mech.storage.IContainerMechanics

CREATE_DEFAULT_CONTAINER, SORT_ITEMNAME, SORT_MODIFIED, SORT_NONE_SPECIFIED, SORT_SORTID, SORT_TYPE

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	Description
boolean	canListWorkspaces(IThingID templateId, IThingID userId, Map<?,?> capabilities)	Returns true if the specified user can list the pages base on the specified template.
void	checkListWorkspaces(IThingID templateId, IThingID userId, Map<?,?> capabilities)	Throws a PortalAccessException if the specified user cannot list the pages based on the specified template.
IListView<IView>	listWorkspaces(IThingID templateId, int start, int end)	Returns a list of the specified length (or less) from the specified start index in the specified template.

Methods inherited from interface com.webmethods.portal.mech.access.IAccessMechanics

canRemoveSecurityRealm, canSetSecurityRealm, checkAccess, checkAccessEx, checkRemoveSecurityRealm, checkSetSecurityRealm, cloneAces, fireRemoveAcccesEvent, fireRemoveSecurityRealmEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireSetSecurityRealmEvent, getAccessEx, getAccessList, getAccessListEx, getAclView, getAuthLevelForAuthScheme, getAuthScheme, getAuthSchemeForAuthLevel, getAuthSchemeForResource, getAvailableAuthSchemes, getDefaultAuthScheme, getRightNameForValue, getRightsForType, getRightValueForName, getSecurityRealm, invalidateAcesForThing, invalidateAcesForUser, listSecurityRealmObjects, removeAces, removeSecurityRealm, setAces, setAcesEx, setSecurityRealm, setSecurityRealm

Methods inherited from interface com.webmethods.portal.mech.storage.IBasicMechanics

addNote, addReference, addRelation, canAddNote, canCloneRemote, canCreate, canDelete, canDestroy, canDoTitlebarAction, canListAccess, canListContainers, canListNotes, canRemoveAccess, canRemoveNote, canSetAccess, canSetAuthentication, canSetOwner, canUninstall, canUpdateContent, canUpdateProperties, canVerb, canViewAuthentication, canViewContent, checkAddNote, checkCloneRemote, checkCreate, checkDelete, checkDestroy, checkListAccess, checkListContainers, checkListNotes, checkRemoveAccess, checkRemoveNote, checkSetAccess, checkSetAuthentication, checkSetOwner, checkUninstall, checkUpdateContent, checkUpdateProperties, checkViewAuthentication, checkViewContent, cloneRemote, copy, create, create, delete, destroy, doAfterInstall, doAfterUpgrade, doBeforeUninstall, doBeforeUpgrade, fireAddNoteEvent, fireCacheInvalidateEvent, fireDeleteEvent, fireInsoEvent, fireListAccessEvent, fireListContainersEvent, fireListNotesEvent, firePurgeEvent, fireRemoveAcccesEvent, fireRemoveNoteEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireUpdateContentEvent, fireUpdatePropertiesEvent, fireViewAuthenticationEvent, fireViewContentEvent, getAccess, getAncestors, getAuthentication, getContent, getContent, getContentStore, getContentStore, getDependencyList, getPrimaryRelatedChild, getPrimaryRelatedContainer, getTimeToLive, isAnonymous, isBaseType, isContainer, isNormal, isReference, isVersionable, isWorkflowEnabled, listAccess, listAccess, listContainers, listContainers, listDependants, listNotes, listRelatedChildren, listRelatedContainers, move, move, prepareForDeletion, removeNote, removeReference, removeRelation, restoreXTypeConfProps, saveXTypeConfProps, setAuthentication, setOwner, setTimeToLive, undeleteAllUndestroyed, updateContent, updateContent, updateProperties, updateProperties

Methods inherited from interface com.webmethods.portal.mech.clipboard.IClipboardMechanics

canCopyToClipboard, canCutToClipboard, checkCopyToClipboard, checkCutToClipboard, copyToClipboard, cutToClipboard, getClipboard, getClipboardInfo, newClipboardItem

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.mech.storage.IContainerMechanics

addReferenceToChild, canAddChild, canAddReference, canListChildren, canRemoveChild, canRemoveReference, checkAddChild, checkAddReference, checkHasPrimaryChild, checkIsDescendantOrSelf, checkListChildren, checkRemoveChild, checkRemoveReference, copyChild, copyChild, createChild, createChild, fireAddChildEvent, fireAddReferenceEvent, fireCopyChildEvent, fireCopyReferenceEvent, fireListChildrenEvent, fireMoveChildEvent, fireMoveChildEvent, fireMoveReferenceEvent, fireRemoveReferenceEvent, getPrimaryChild, getPrimaryChildNoCache, getReference, getSelectedListView, getSelectedListView, hasPrimaryChild, hasReference, isDescendantOrSelf, listChildren, listChildren, listChildren, listChildren, listChildren, listChildren, listChildren, listChildren, listChildren, listDescendants, listDescendants, listDescendants, listDescendants, makeUniqueName, matchChildren, matchChildren, matchChildren, matchChildren, matchChildren, matchChildren, moveChild, moveChild, removeReferenceToChild, viewPrimaryChild

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

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.storage.IVersionableMechanics

addToVersioning, canAddToVersioning, canCheckIn, canCheckOut, canListVersions, canPublishVersion, canRemoveFromVersioning, canSetCurrentVersion, canUndoCheckOut, canViewVersion, checkAddToVersioning, checkCheckIn, checkCheckOut, checkIn, checkListVersions, checkOut, checkPublishVersion, checkRemoveFromVersioning, checkSetCurrentVersion, checkUndoCheckOut, checkViewVersion, fireAddToVersioningEvent, fireCheckInEvent, fireCheckOutEvent, fireListVersionsEvent, firePublishVersionEvent, fireRemoveFromVersioningEvent, fireSetCurrentVersionEvent, fireUndoCheckOutEvent, fireViewVersionEvent, getCheckedOutBy, getVersion, isCheckedOut, isVersioned, listVersions, publishVersion, removeFromVersioning, setCurrentVersion, undoCheckOut, viewVersion

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

createPagingCookie

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

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

Method Details

canListWorkspaces

boolean canListWorkspaces(IThingID templateId,
 IThingID userId,
 Map<?,?> capabilities)
                   throws PortalException

Returns true if the specified user can list the pages base on the specified template.

Parameters:

templateId - Template to analyze

userId - User that requests workspace listing (for filtering)

capabilities - Optional capabilities map

Returns:

True, if the user can list workspaces, False - otherwise

Throws:

PortalException

checkListWorkspaces

void checkListWorkspaces(IThingID templateId,
 IThingID userId,
 Map<?,?> capabilities)
                  throws PortalException,
PortalAccessException

Throws a PortalAccessException if the specified user cannot list the pages based on the specified template.

Parameters:

templateId - Template to analyze

userId - User that requests workspace listing (for filtering)

capabilities - Optional capabilities map

Throws:

PortalException - if operation fails (except access)

PortalAccessException - if user cannot list workspace because of access rights

listWorkspaces

IListView<IView> listWorkspaces(IThingID templateId,
 int start,
 int end)
                         throws PortalException

Returns a list of the specified length (or less) from the specified start index in the specified template.

Parameters:

templateId - Template whose pages to list.

start - List starting index (0 for first item).

end - List length (<1 for all items).

Returns:

List of IView items, or an empty list.

Throws:

PortalException - if operation fails