public interface IFolderMechanics extends IContainerMechanics
Mechanics specific to resources of type IFolder
.
No new methods are defined, but custom behaviour is overriden from the IContainerMechanics
and the IBasicMechanics
.
CREATE_DEFAULT_CONTAINER, SORT_ITEMNAME, SORT_MODIFIED, SORT_NONE_SPECIFIED, SORT_SORTID, SORT_TYPE
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
CONTENT_FORMAT_EMAIL, CONTENT_FORMAT_EMAIL_DIGEST, CONTENT_FORMAT_PORTAL_INBOX, CONTENT_FORMAT_PORTAL_INBOX_DIGEST, HEADER_FROM, HEADER_SUBJECT, HEADER_TO
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
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
Modifier and Type | Method and Description |
---|---|
boolean |
canChangeColumns(IThingID folderId,
IThingID userId,
Map<?,?> capabilities)
Returns true if the specified user can change the column layout of the specified page.
|
boolean |
canMinimizePortlet(IThingID folderId,
IThingID userId,
IThingID portletId,
Map<?,?> capabilities)
Returns true if the specified user can minimize the specified portlet.
|
boolean |
canMovePortlet(IThingID folderId,
IThingID userId,
IThingID portletId,
Map<?,?> capabilities)
Returns true if the specified user can move the specified portlet in the specified page.
|
void |
changeColumns(IThingID folderId,
IThingID userId,
ColumnLocation[][] columns)
Deprecated.
use
setPageData(IThingID, IThingID, PageData) instead |
void |
checkChangeColumns(IThingID folderId,
IThingID userId,
Map<?,?> capabilities)
Throws a
PortalAccessException if the specified user cannot change the column layout of the specified page. |
void |
checkMinimizePortlet(IThingID folderId,
IThingID userId,
IThingID portletId,
Map<?,?> capabilities)
Throws a
PortalAccessException if the specified user cannot minimize the specified portlet. |
void |
checkMovePortlet(IThingID folderId,
IThingID userId,
IThingID portletId,
Map<?,?> capabilities)
Throws a
PortalAccessException if the specified user cannot move the specified portlet in the specified page. |
void |
fireChangeColumnsEvent(IThingID itemId,
IThingID userId,
int status,
ColumnLocation[][] columns)
Fires a page column layout changed event.
|
void |
fireMinimizePortletEvent(IThingID itemId,
IThingID userId,
int status,
IThingID portletId)
Fires a portlet minimized event.
|
void |
fireModifyLayoutEvent(IThingID itemId,
IThingID userId,
int status)
Fires a page layout modified event.
|
void |
fireMovePortletsEvent(IThingID itemId,
IThingID userId,
int status,
PortletLocation[] deltaLocations)
Fires a page portlets moved changed event.
|
PageData |
getPageData(IThingID folderId,
IThingID userId)
Builds
PageData structure for specified folder. |
void |
handlePortletBeansExpiration(IThingID folderID)
Handles portlet bean expiration for a given folderID
|
IThingIDList |
listHoboPortlets(IThingID folderId,
IThingID userId)
Lists the all the portlets on the specified page
viewable by the specified user -- but not yet specified in the page layout.
|
IThingIDList |
listPortlets(IThingID folderId,
IThingID userId)
Lists the all the portlets on the specified page
viewable by the specified user.
|
void |
minimizePortlet(IThingID folderId,
IThingID userId,
IThingID portletId,
boolean minimize)
Deprecated.
Minimizes or un-minimizes the specified portlet.
|
void |
movePortlets(IThingID folderId,
IThingID userId,
PortletLocation[] deltaLocations)
Deprecated.
use
setPageData(IThingID, IThingID, PageData) instead |
void |
personalizePageData(IThingID folderId,
IThingID userId,
PageData page)
Filter page data through acls, etc.
|
void |
setPageData(IThingID folderId,
IThingID userId,
PageData page)
Persists
PageData structure for specified folder. |
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
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
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
canCopyToClipboard, canCutToClipboard, checkCopyToClipboard, checkCutToClipboard, copyToClipboard, cutToClipboard, getClipboard, getClipboardInfo, newClipboardItem
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
canView, checkView, createPagingCookie, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, getListPropertyHTML, getListPropertyJS, isEnabled, view, view
getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider
init, shutdown
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
createPagingCookie
boolean canChangeColumns(IThingID folderId, IThingID userId, Map<?,?> capabilities) throws PortalException
PortalException
void checkChangeColumns(IThingID folderId, IThingID userId, Map<?,?> capabilities) throws PortalException, PortalAccessException
PortalAccessException
if the specified user cannot change the column layout of the specified page.PortalException
PortalAccessException
boolean canMovePortlet(IThingID folderId, IThingID userId, IThingID portletId, Map<?,?> capabilities) throws PortalException
PortalException
void checkMovePortlet(IThingID folderId, IThingID userId, IThingID portletId, Map<?,?> capabilities) throws PortalException, PortalAccessException
PortalAccessException
if the specified user cannot move the specified portlet in the specified page.PortalException
PortalAccessException
boolean canMinimizePortlet(IThingID folderId, IThingID userId, IThingID portletId, Map<?,?> capabilities) throws PortalException
PortalException
void checkMinimizePortlet(IThingID folderId, IThingID userId, IThingID portletId, Map<?,?> capabilities) throws PortalException, PortalAccessException
PortalAccessException
if the specified user cannot minimize the specified portlet.PortalException
PortalAccessException
void handlePortletBeansExpiration(IThingID folderID) throws PortalException
folderID
- PortalException
void fireModifyLayoutEvent(IThingID itemId, IThingID userId, int status) throws PortalException
itemId
- Page which changed.userId
- User who made the change.status
- Status of the event (successful, denied, error).PortalException
- if the userId is invalid.void fireChangeColumnsEvent(IThingID itemId, IThingID userId, int status, ColumnLocation[][] columns) throws PortalException
itemId
- Page which changed.userId
- User who made the change.status
- Status of the event (successful, denied, error).columns
- New column layout.PortalException
- if the userId is invalid.void fireMovePortletsEvent(IThingID itemId, IThingID userId, int status, PortletLocation[] deltaLocations) throws PortalException
itemId
- Page which changed.userId
- User who made the change.status
- Status of the event (successful, denied, error).deltaLocations
- Changed portlet locations.PortalException
- if the userId is invalid.void fireMinimizePortletEvent(IThingID itemId, IThingID userId, int status, IThingID portletId) throws PortalException
itemId
- Page which changed.userId
- User who made the change.status
- Status of the event (successful, denied, error).portletId
- Portlet changed.PortalException
- if the userId is invalid.@Deprecated void changeColumns(IThingID folderId, IThingID userId, ColumnLocation[][] columns) throws PortalException
setPageData(IThingID, IThingID, PageData)
insteadfolderId
- Page to modify.userId
- User for which to modify.columns
- New column layout. Do not include PortletData
!PortalException
@Deprecated void movePortlets(IThingID folderId, IThingID userId, PortletLocation[] deltaLocations) throws PortalException
setPageData(IThingID, IThingID, PageData)
insteadfolderId
- Page to modify.userId
- User for which to modify.deltaLocations
- Sequence of portlet movement.PortalException
@Deprecated void minimizePortlet(IThingID folderId, IThingID userId, IThingID portletId, boolean minimize) throws PortalException
minimize
- True to minimize, false to un-minimize.PortalException
IThingIDList listPortlets(IThingID folderId, IThingID userId) throws PortalException
PortalException
IThingIDList listHoboPortlets(IThingID folderId, IThingID userId) throws PortalException
PortalException
PageData getPageData(IThingID folderId, IThingID userId) throws PortalException
PageData
structure for specified folder.
If folder has no page info, returns null.PortalException
void setPageData(IThingID folderId, IThingID userId, PageData page) throws PortalException
PageData
structure for specified folder.PortalException
void personalizePageData(IThingID folderId, IThingID userId, PageData page) throws PortalException
PortalException