com.atlassian.confluence.spaces.actions
Class ListAttachmentsAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.atlassian.confluence.core.ConfluenceActionSupport
          extended by com.atlassian.confluence.spaces.actions.AbstractSpaceAction
              extended by com.atlassian.confluence.spaces.actions.ListAttachmentsAction
All Implemented Interfaces:
Evented<AttachmentListViewEvent>, WebInterface, SpaceAware, Spaced, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

public class ListAttachmentsAction
extends AbstractSpaceAction
implements SpaceAware, Evented<AttachmentListViewEvent>

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.atlassian.confluence.spaces.actions.AbstractSpaceAction
key, notificationManager, originalSpace, space, spaceManager, wikiStyleRenderer
 
Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, permissionManager, permitted, pluginAccessor, PREVIEW, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager
 
Fields inherited from class com.opensymphony.xwork.ActionSupport
LOG
 
Fields inherited from interface com.opensymphony.xwork.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
ListAttachmentsAction()
           
 
Method Summary
 String execute()
           
 AttachmentListViewEvent getEventToPublish(String result)
          Gets the event to publish.
 String getFileExtension()
           
 String getLabels()
           
 int getLabelsCount()
           
 PaginationSupport getPaginationSupport()
           
 String getSortBy()
           
 boolean isSpaceRequired()
          If the action requires that the space be set before being run, then it should return true to this method.
 boolean isViewPermissionRequired()
           
 void setFileExtension(String fileExtension)
           
 void setLabels(String labels)
           
 void setSearchManager(SearchManager searchManager)
           
 void setSortBy(String sortBy)
           
 void setStartIndex(int startIndex)
           
 
Methods inherited from class com.atlassian.confluence.spaces.actions.AbstractSpaceAction
getKey, getPermissionTypes, getSpace, getSpaceKey, getSubscribableName, isAdminUser, isPermitted, isPersonalSpace, isSuperUser, isUserWatchingSpace, isValidSpaceKey, setKey, setNotificationManager, setSpace, setSpaceManager, setWikiStyleRenderer
 
Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getBootstrapManager, getCancelResult, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getNiceContentType, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setBootstrapManager, setCancel, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setSystemInformationService, setUserAccessor, setWebInterfaceManager
 
Methods inherited from class com.opensymphony.xwork.ActionSupport
addActionError, addActionMessage, addFieldError, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.atlassian.confluence.spaces.actions.SpaceAware
setSpace
 
Methods inherited from interface com.atlassian.confluence.spaces.Spaced
getSpace
 

Constructor Detail

ListAttachmentsAction

public ListAttachmentsAction()
Method Detail

execute

public String execute()
               throws Exception
Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class com.opensymphony.xwork.ActionSupport
Throws:
Exception

getEventToPublish

public AttachmentListViewEvent getEventToPublish(String result)
Description copied from interface: Evented
Gets the event to publish.

Specified by:
getEventToPublish in interface Evented<AttachmentListViewEvent>
Parameters:
result - the result of the action executing.
Returns:
the event. Can be null, in which case no event will be published.

isSpaceRequired

public boolean isSpaceRequired()
Description copied from interface: SpaceAware
If the action requires that the space be set before being run, then it should return true to this method. If the action requires a space, but no space is available, then the interceptor will automatically redirect to the 'pagenotfound' result

Specified by:
isSpaceRequired in interface SpaceAware
Returns:
true if the action requires a space in order to execute

isViewPermissionRequired

public boolean isViewPermissionRequired()
Specified by:
isViewPermissionRequired in interface SpaceAware
Returns:
true if the action requires view space permission

getPaginationSupport

public PaginationSupport getPaginationSupport()

getSortBy

public String getSortBy()

setSortBy

public void setSortBy(String sortBy)

getFileExtension

public String getFileExtension()

setFileExtension

public void setFileExtension(String fileExtension)

setLabels

public void setLabels(String labels)

getLabels

public String getLabels()

getLabelsCount

public int getLabelsCount()

setStartIndex

public void setStartIndex(int startIndex)

setSearchManager

public void setSearchManager(SearchManager searchManager)


Copyright © 2003-2012 Atlassian. All Rights Reserved.