public interface SiteService extends Service
IllegalArgumentException
.Modifier and Type | Method and Description |
---|---|
boolean |
addUserPreference(String userid, String siteid, String name, String value)
Adds or updates user preferences for the logged in user
|
boolean |
canPlacePage(long siteId)
Checks if the logged in user is able to place pages in the specified site.
|
List<RoleBean> |
getAllRoles()
Returns a list of all roles in the system.
|
List<String> |
getEnabledTypes(long siteId)
Returns the list of asset types enabled in the specified site.
|
List<String> |
getLocales(long siteId)
Get available Locales for a given site.
|
List<UserBean> |
getSiteUsers(long siteId)
Returns the list of those users who have access to the specified site through one or more roles.
|
List<StartMenuBean> |
getStartMenus(List<StartMenuBean.Type> itemTypes, List<String> assetTypes, long siteId)
Returns the list of start menu items for specific asset types for the specified user in the specified site.
|
List<StartMenuBean> |
getStartMenus(List<StartMenuBean.Type> types, long siteId)
Returns the list of start menu items for the specified user in the specified site.
|
String |
getUserPreference(String userid, String siteid, String name)
fetch user preference value for login user in specific site
|
Map<String,String> |
getUserPreferences(String userid, String siteid)
retrieve user preferences for login user in the specified site.
|
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.
|
boolean |
placePagesSPN(SitePlanNodeBean child, SitePlanNodeBean target, List<AssetId> children, SitePlanNodeBean previous)
Places a Page asset under the specified parent Page asset at the specified index.
|
boolean |
removeUserPreference(String userid, String siteid, String name)
add / update user preferences for login user
|
Boolean |
unPlacePagesSPN(SitePlanNodeBean child, SitePlanNodeBean previous, SitePlanNodeBean target, List<AssetId> children)
Unplaces placed pages from a parent.
|
getManager, getResponse, setManager
boolean isPreviewEnabled(long siteId) throws ServiceException
siteId
- id of the site in which the asset types are enabled.ServiceException
- wraps any exception underlying the service call.List<String> getEnabledTypes(long siteId) throws ServiceException
siteId
- id of the site in which the asset types are enabled.ServiceException
- wraps any exception underlying the service call.List<UserBean> getSiteUsers(long siteId) throws ServiceException
siteId
- id of the site in which the users have access.ServiceException
- wraps any exception underlying the service call.List<RoleBean> getAllRoles() throws ServiceException
ServiceException
- wraps any exception underlying the service call.List<RoleBean> getUserRoles(long siteId) throws ServiceException
siteId
- id of the site in which the asset types are enabled.ServiceException
- wraps any exception underlying the service call.List<StartMenuBean> getStartMenus(List<StartMenuBean.Type> types, long siteId) throws ServiceException
types
- the list of start menu types.siteId
- the site for which the start menu is to be retrieved.ServiceException
- wraps any exception underlying the service call.StartMenuBean.Type
List<StartMenuBean> getStartMenus(List<StartMenuBean.Type> itemTypes, List<String> assetTypes, long siteId) throws ServiceException
itemTypes
- the list of start menu types.assetTypes
- the list of asset types.siteId
- the site for which the start menu is to be retrieved.ServiceException
- wraps any exception underlying the service call.StartMenuBean.Type
List<String> getLocales(long siteId) throws ServiceException
siteId
- the site for which the locales are to be retrieved.ServiceException
- wraps any exception underlying the service call.boolean canPlacePage(long siteId) throws ServiceException
siteId
- the site in which the pages are to be placed.ServiceException
- wraps any exception underlying the service call.boolean placePagesSPN(SitePlanNodeBean child, SitePlanNodeBean target, List<AssetId> children, SitePlanNodeBean previous) throws ServiceException
child
- the childtarget
- the targetchildren
- the childrenprevious
- the previousServiceException
- wraps any exception underlying the service call.Boolean unPlacePagesSPN(SitePlanNodeBean child, SitePlanNodeBean previous, SitePlanNodeBean target, List<AssetId> children) throws ServiceException
child
- the childtarget
- the targetchildren
- the childrenprevious
- the previoustrue
if the operation is successful, false
otherwiseServiceException
- wraps any exception underlying the service call.Map<String,String> getUserPreferences(String userid, String siteid) throws ServiceException
siteid
- the site in which the pages are to be placed.userid
- the userid of the loggedin userString
representing the attribute nameString
representing the tab idServiceException
- wraps any exception underlying the service call.boolean addUserPreference(String userid, String siteid, String name, String value) throws ServiceException
siteid
- the site in which the pages are to be placed.name
- the name of the useruserid
- the userid of the loggedin uservalue
- the value of the preferenceString
representing the attribute nameString
representing the tab idServiceException
- wraps any exception underlying the service call.String getUserPreference(String userid, String siteid, String name) throws ServiceException
siteid
- the site in which the pages are to be placed.userid
- the userid of the loggedin username
- the name of the userString
representing the attribute nameString
representing the tab idServiceException
- wraps any exception underlying the service call.boolean removeUserPreference(String userid, String siteid, String name) throws ServiceException
siteid
- the site in which the pages are to be placed.userid
- the userid of the loggedin username
- the name of the userMap
where:
String
representing the attribute nameString
representing the tab idServiceException
- wraps any exception underlying the service call.