Package com.jalios.jcms.workspace
Class FavoriteWorkspaceManager
java.lang.Object
com.jalios.jcms.workspace.FavoriteWorkspaceManager
Manager to get/set Member's favorite workspaces.
- Since:
- jcms-10.0.0
- Author:
- Sylvain Devaux
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds given workspace(s) as favorite for given member.voidClears all member's favorite workspaces.Return ordered list of favorite Workspaces for given member.static FavoriteWorkspaceManagerGet the manager.booleanhasFavorites(Member member) Returns true if member has at least one favorite workspace.booleanisFavorite(Member member, Workspace workspace) voidRemoves given workspace from member's favorite workspaces.voidSets given workspace(s) as favorite for given member, and replaces current ones if any.
-
Field Details
-
FAVORITE_WORKSPACES_MEMBERPREFS_KEY
- See Also:
-
-
Method Details
-
getInstance
Get the manager.- Returns:
- FavoriteWorkspaceManager the singleton instance
-
add
Adds given workspace(s) as favorite for given member.- Parameters:
member- the memberworkspaces- the favorite workspace(s) to add
-
set
Sets given workspace(s) as favorite for given member, and replaces current ones if any.- Parameters:
member- the memberworkspaces- the favorite workspace(s) to add
-
get
Return ordered list of favorite Workspaces for given member.- Parameters:
member- the member- Returns:
- a Workspace Collection, or an empty collection
-
remove
Removes given workspace from member's favorite workspaces.- Parameters:
member- the memberworkspace- the workspace to remove from the member's favorites
-
clear
Clears all member's favorite workspaces.- Parameters:
member- the member
-
isFavorite
- Parameters:
member- the memberworkspace- the workspace to test if it is a favorite- Returns:
- true if given workspace is a favorite workspace for given member
-
hasFavorites
Returns true if member has at least one favorite workspace.- Parameters:
member- the member- Returns:
- true if member has at least one favorite workspace.
-