|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SiteDao
The Site Data Access Object provides access to site, user, role and start menu related data.
The site service depends on the SiteDao
to provide the access it requires to pull up this data. For the methods in this service which accept a site id, if the value of the site id is less than or equal to 0, then that method throws an IllegalArgumentException
.
Method Summary | |
---|---|
java.util.List<RoleBean> |
getAllRoles() Returns a list of all roles in the system. |
java.util.List<java.lang.String> |
getEnabledTypes(long siteId) Returns the list of asset types enabled in the specified site. |
java.util.List<java.lang.String> |
getLocales(long siteId) Returns available locales for the specified site. |
java.util.List<UserBean> |
getSiteUsers(long siteId) Returns the list of those users who have access to the specified site through one or more roles. |
java.util.List<StartMenuBean> |
getStartMenus(java.util.List<StartMenuBean.Type> types, long siteId) Returns the list of start menu items for the logged in user in the specified site. |
java.util.List<RoleBean> |
getUserRoles(long siteId) Returns a list of all roles for the logged in user in the specified site. |
boolean |
isPreviewEnabled(long siteId) Checks whether preview is enabled for assets in the specified site. |
Methods inherited from interface com.fatwire.services.dao.DataAccessObject |
---|
getResponse, getService, setService |
Method Detail |
---|
boolean isPreviewEnabled(long siteId) throws DataAccessException
true
if preview is enabled in the specified site.DataAccessException
- wraps any underlying exception caused during data access.java.util.List<java.lang.String> getEnabledTypes(long siteId) throws DataAccessException
siteId
- id of the site in which the asset types are enabled.DataAccessException
- wraps any underlying exception caused during data access.java.util.List<UserBean> getSiteUsers(long siteId) throws DataAccessException
siteId
- id of the site in which the users have access.DataAccessException
- wraps any underlying exception caused during data access.java.util.List<RoleBean> getAllRoles() throws DataAccessException
DataAccessException
- wraps any underlying exception caused during data access.java.util.List<RoleBean> getUserRoles(long siteId) throws DataAccessException
DataAccessException
- wraps any underlying exception caused during data access.java.util.List<StartMenuBean> getStartMenus(java.util.List<StartMenuBean.Type> types, long siteId) throws DataAccessException
Returns the list of start menu items for the logged in user in the specified site.
The start menu items available to a user in a site are based on the roles assigned to the user in that site. The returned list will contain a union of start menu items for each start menu type specified.types
- the list of start menu types.site
- the site for which the start menu is to be retrieved.DataAccessException
- wraps any underlying exception caused during data access.StartMenuBean.Type
java.util.List<java.lang.String> getLocales(long siteId) throws DataAccessException
site
- the site for which the locales are to be retrieved.DataAccessException
- wraps any underlying exception caused during data access.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.