com.stratelia.silverpeas.selection
Class Selection

java.lang.Object
  extended by com.stratelia.silverpeas.selection.Selection

public final class Selection
extends Object


Field Summary
protected  String cancelURL
           
protected  boolean elementSelectable
           
protected  SelectionExtraParams extraParams
           
protected  boolean filterOnDeactivatedState
           
static String FIRST_PAGE_BROWSE
           
static String FIRST_PAGE_CART
           
static String FIRST_PAGE_DEFAULT
           
static String FIRST_PAGE_SEARCH_ELEMENT
           
static String FIRST_PAGE_SEARCH_SET
           
protected  String firstPage
           
protected  String goBackURL
           
protected  PairObject hostComponentName
           
protected  PairObject[] hostPath
           
protected  String hostSpaceName
           
protected  String htmlFormElementId
           
protected  String htmlFormElementName
           
protected  String htmlFormElementType
           
protected  String htmlFormName
           
protected  boolean multiSelect
           
protected  boolean popupMode
           
protected  List<Domain> registeredServerDomains
           
protected  String[] selectedElements
           
protected  String[] selectedSets
           
protected  int selectedUserLimit
           
protected  boolean setSelectable
           
static String TYPE_JDBC_CONNECTOR
           
static String TYPE_SELECTED_ELEMENT
           
static String TYPE_SELECTED_SET
           
static String TYPE_SPACES_COMPONENTS
           
static String TYPE_USERS_GROUPS
           
static String USER_SELECTION_PANEL_PATH
           
 
Constructor Summary
Selection()
           
 
Method Summary
 String getCancelURL()
           
 SelectionExtraParams getExtraParams()
           
 String getFirstPage()
           
 String getFirstSelectedElement()
           
 String getFirstSelectedSet()
           
 String getGoBackURL()
           
 PairObject getHostComponentName()
           
 PairObject[] getHostPath()
           
 String getHostSpaceName()
           
 String getHtmlFormElementId()
           
 String getHtmlFormElementName()
           
 String getHtmlFormElementType()
           
 String getHtmlFormName()
           
 List<Domain> getRegisteredServerDomains()
          Gets all the domains registered on the server.
 String[] getSelectedElements()
           
 String[] getSelectedSets()
           
 int getSelectedUserLimit()
           
static String getSelectionURL(String selectionType)
           
 boolean isElementSelectable()
           
 boolean isFilterOnDeactivatedState()
           
 boolean isHotSetting()
          Is the set of fields with the selection could be done directly from the user panel ?
 boolean isMultiSelect()
           
 boolean isPopupMode()
           
 boolean isSetSelectable()
           
 void resetAll()
           
 void setCancelURL(String cancelURL)
           
 void setElementSelectable(boolean elementSelectable)
           
 void setExtraParams(SelectionExtraParams extraParams)
           
 void setFilterOnDeactivatedState(boolean filterOnDeactivatedState)
           
 void setFirstPage(String firstPage)
           
 void setGoBackURL(String goBackURL)
           
 void setHostComponentName(PairObject hostComponentName)
           
 void setHostPath(PairObject[] hostPath)
           
 void setHostSpaceName(String hostSpaceName)
           
 void setHtmlFormElementId(String formElementId)
           
 void setHtmlFormElementName(String formElementName)
           
 void setHtmlFormElementType(String formElementType)
           
 void setHtmlFormName(String formName)
           
 void setMultiSelect(boolean multiSelect)
           
 void setPopupMode(boolean popupMode)
           
 void setSelectedElements(Collection<String> selectedElements)
           
 void setSelectedElements(String[] selectedElements)
           
 void setSelectedSets(Collection<String> selectedSets)
           
 void setSelectedSets(String[] selectedSets)
           
 void setSelectedUserLimit(int selectedUserLimit)
           
 void setSetSelectable(boolean setSelectable)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE_USERS_GROUPS

public static final String TYPE_USERS_GROUPS
See Also:
Constant Field Values

TYPE_SPACES_COMPONENTS

public static final String TYPE_SPACES_COMPONENTS
See Also:
Constant Field Values

TYPE_JDBC_CONNECTOR

public static final String TYPE_JDBC_CONNECTOR
See Also:
Constant Field Values

FIRST_PAGE_DEFAULT

public static final String FIRST_PAGE_DEFAULT
See Also:
Constant Field Values

FIRST_PAGE_CART

public static final String FIRST_PAGE_CART
See Also:
Constant Field Values

FIRST_PAGE_SEARCH_ELEMENT

public static final String FIRST_PAGE_SEARCH_ELEMENT
See Also:
Constant Field Values

FIRST_PAGE_SEARCH_SET

public static final String FIRST_PAGE_SEARCH_SET
See Also:
Constant Field Values

FIRST_PAGE_BROWSE

public static final String FIRST_PAGE_BROWSE
See Also:
Constant Field Values

USER_SELECTION_PANEL_PATH

public static final String USER_SELECTION_PANEL_PATH
See Also:
Constant Field Values

TYPE_SELECTED_SET

public static final String TYPE_SELECTED_SET
See Also:
Constant Field Values

TYPE_SELECTED_ELEMENT

public static final String TYPE_SELECTED_ELEMENT
See Also:
Constant Field Values

registeredServerDomains

protected List<Domain> registeredServerDomains

goBackURL

protected String goBackURL

cancelURL

protected String cancelURL

htmlFormName

protected String htmlFormName

htmlFormElementName

protected String htmlFormElementName

htmlFormElementId

protected String htmlFormElementId

htmlFormElementType

protected String htmlFormElementType

firstPage

protected String firstPage

selectedSets

protected String[] selectedSets

selectedElements

protected String[] selectedElements

popupMode

protected boolean popupMode

multiSelect

protected boolean multiSelect

setSelectable

protected boolean setSelectable

elementSelectable

protected boolean elementSelectable

hostSpaceName

protected String hostSpaceName

hostComponentName

protected PairObject hostComponentName

hostPath

protected PairObject[] hostPath

extraParams

protected SelectionExtraParams extraParams

selectedUserLimit

protected int selectedUserLimit

filterOnDeactivatedState

protected boolean filterOnDeactivatedState
Constructor Detail

Selection

public Selection()
Method Detail

resetAll

public void resetAll()

getSelectionURL

public static String getSelectionURL(String selectionType)

setHostSpaceName

public void setHostSpaceName(String hostSpaceName)

getHostSpaceName

public String getHostSpaceName()

setHostComponentName

public void setHostComponentName(PairObject hostComponentName)

getHostComponentName

public PairObject getHostComponentName()

setHostPath

public void setHostPath(PairObject[] hostPath)

getHostPath

public PairObject[] getHostPath()

getCancelURL

public String getCancelURL()

setCancelURL

public void setCancelURL(String cancelURL)

getGoBackURL

public String getGoBackURL()

setGoBackURL

public void setGoBackURL(String goBackURL)

getFirstPage

public String getFirstPage()

setFirstPage

public void setFirstPage(String firstPage)

isPopupMode

public boolean isPopupMode()

setPopupMode

public void setPopupMode(boolean popupMode)

isHotSetting

public boolean isHotSetting()
Is the set of fields with the selection could be done directly from the user panel ? This can be done only if : - the user panel is opened within a window popup (PopupMode = true), - not with multi selection (MultiSelect = false) and - the information about HTML form of the opener is provided (see the setHtmlForm kind methods).

Returns:
true if the user panel should modify directly the opener with the result of the selection, false otherwise.

isMultiSelect

public boolean isMultiSelect()

setMultiSelect

public void setMultiSelect(boolean multiSelect)

isSetSelectable

public boolean isSetSelectable()

setSetSelectable

public void setSetSelectable(boolean setSelectable)

isElementSelectable

public boolean isElementSelectable()

setElementSelectable

public void setElementSelectable(boolean elementSelectable)

getSelectedElements

public String[] getSelectedElements()

setSelectedElements

public void setSelectedElements(String[] selectedElements)

setSelectedElements

public void setSelectedElements(Collection<String> selectedElements)

getFirstSelectedElement

public String getFirstSelectedElement()

getSelectedSets

public String[] getSelectedSets()

setSelectedSets

public void setSelectedSets(String[] selectedSets)

setSelectedSets

public void setSelectedSets(Collection<String> selectedSets)

getFirstSelectedSet

public String getFirstSelectedSet()

getExtraParams

public SelectionExtraParams getExtraParams()

setExtraParams

public void setExtraParams(SelectionExtraParams extraParams)

getHtmlFormElementId

public String getHtmlFormElementId()

setHtmlFormElementId

public void setHtmlFormElementId(String formElementId)

getHtmlFormElementName

public String getHtmlFormElementName()

setHtmlFormElementName

public void setHtmlFormElementName(String formElementName)

getHtmlFormName

public String getHtmlFormName()

setHtmlFormName

public void setHtmlFormName(String formName)

getHtmlFormElementType

public String getHtmlFormElementType()

setHtmlFormElementType

public void setHtmlFormElementType(String formElementType)

getSelectedUserLimit

public int getSelectedUserLimit()

setSelectedUserLimit

public void setSelectedUserLimit(int selectedUserLimit)

getRegisteredServerDomains

public List<Domain> getRegisteredServerDomains()
Gets all the domains registered on the server.


isFilterOnDeactivatedState

public boolean isFilterOnDeactivatedState()

setFilterOnDeactivatedState

public void setFilterOnDeactivatedState(boolean filterOnDeactivatedState)


Copyright © 2016 Silverpeas. All Rights Reserved.