Package com.emc.d2fs.interfaces
Interface IPreferenceService
- All Superinterfaces:
ID2fsService
Preferences service. Provide access to user preferences in given context.
-
Method Summary
Modifier and TypeMethodDescriptiongetColumnPreferences
(Context context, String colType) Get column preferences for specified column typegetColumnSelectSettings
(Context context, String coltype, boolean asDefault) Get columns set for current usergetColumnSrcSettings
(Context context, String colType, String typeName) Get columns list for specified object type and column typegetColumnTypeSettings
(Context context) Get object type list (dm_document, ...)getFilters
(Context context, String id) Get all available filters to filter children document listgetLanguage
(Context context) Get language preferencegetPreference
(Context context) Get preferences for current usergetPreferenceWithColumn
(Context context, String colType) Get preferences for current user with column objects filledboolean
getSearchHighlightEnabled
(Context context) boolean
getSearchSummaryEnabled
(Context context) boolean
setColumnPreference
(Context context, ColumnPreference columnPreference, boolean asDefault) Set columns for current userboolean
setColumnSelectSettings
(Context context, List<Option> options, String colType, boolean asDefault) Set columns for current userboolean
setFilterActive
(Context context, String filterName) Set active filterboolean
setSearchHighlightEnabled
(Context context, boolean isEnabled) boolean
setSearchSummaryEnabled
(Context context, boolean isEnabled) boolean
setTemplateViewPreference
(Context context, String templateView) Set Template View preferenceupdatePreferences
(Context context, Preference updatePreferences) Update user preferencesdefault void
updatePreferences
(Context context, Preference updatePreferences, Map<String, String> params) default implemetnetation.Methods inherited from interface com.emc.d2fs.interfaces.ID2fsService
isRemote, setRemote
-
Method Details
-
getPreference
Get preferences for current user- Parameters:
context
-Context
object containing informations about client/session- Returns:
Preference
object containing following attributes :- List of column object : Complex object containing following attributes :
- name : String value of column name
- label : String value of displayed label
- width : Integer value of column width
- type : Integer value of column type
- direction : String value of direction
- fixed : Boolean value for fixed state (not resizable)
- List of columnPreferences object : Complex object containing following attributes :
- List of column object
- Coltype : String value of column type
- language : String value of language name
- folderBefore : Boolean value of is folder before document in doclist
- folderHidden : Boolean value of is hidden folder in tree browser
- formatDate : String value of date format (i.e : MM/dd/yyyy)
- formatDateTime : String value of date with time format (i.e : hh:mm:ss MM/dd/yyyy)
- thumbnailFormat : String value of thumbnail format
- thumbnailSize : String value of thumbnail size (16x16, 32x32, 64x64)
- contentViewMode : String value of content view mode
- List of column object : Complex object containing following attributes :
- Throws:
Exception
- Since:
- 4.0.1
-
getColumnPreferences
Get column preferences for specified column type -
getPreferenceWithColumn
Get preferences for current user with column objects filled- Parameters:
context
-Context
object containing informations about client/sessioncolType
- String value of column type (i.e : Search type)- Returns:
Preference
- Throws:
Exception
- Since:
- 4.0.1
-
getColumnTypeSettings
Get object type list (dm_document, ...) -
getColumnSelectSettings
List<Option> getColumnSelectSettings(Context context, String coltype, boolean asDefault) throws Exception Get columns set for current user -
getColumnSrcSettings
List<Option> getColumnSrcSettings(Context context, String colType, String typeName) throws Exception Get columns list for specified object type and column type -
getFilters
Get all available filters to filter children document list -
setFilterActive
Set active filter -
setColumnSelectSettings
boolean setColumnSelectSettings(Context context, List<Option> options, String colType, boolean asDefault) throws Exception Set columns for current user- Parameters:
context
-Context
object containing informations about client/sessionoptions
-Option
list of columnscolType
- String value of column type (i.e : Search type)asDefault
- Boolean value for default column (not user choice)- Returns:
- true if process performs without error
- Throws:
Exception
- Since:
- 4.0.1
-
setColumnPreference
boolean setColumnPreference(Context context, ColumnPreference columnPreference, boolean asDefault) throws Exception Set columns for current user- Parameters:
context
-Context
object containing informations about client/sessioncolumnPreference
-ColumnPreference
preference for columnasDefault
- Boolean value for default column (not user choice)- Returns:
- true if process performs without error
- Throws:
Exception
- Since:
- 4.1.0
-
getLanguage
Get language preference -
setTemplateViewPreference
Set Template View preference -
updatePreferences
Update user preferences- Parameters:
context
-updatePreferences
-- Returns:
- Throws:
Exception
-
updatePreferences
default void updatePreferences(Context context, Preference updatePreferences, Map<String, String> params) throws Exceptiondefault implemetnetation. This approach is taken to make sure other classes who implment this interface do not need to implement this method. This is a overloaded method. It takes an extra map having the params which are are part of x3 preferences. This method updates d2c preferences as well as x3 preferences.- Parameters:
context
-updatePreferences
-params
-- Throws:
Exception
-
setSearchHighlightEnabled
- Throws:
Exception
-
getSearchHighlightEnabled
- Throws:
Exception
-
setSearchSummaryEnabled
- Throws:
Exception
-
getSearchSummaryEnabled
- Throws:
Exception
-