Liferay 6.2-ce-ga5

com.liferay.portal.service.impl
Class LayoutServiceImpl

java.lang.Object
  extended by com.liferay.portal.service.BaseServiceImpl
      extended by com.liferay.portal.service.base.LayoutServiceBaseImpl
          extended by com.liferay.portal.service.impl.LayoutServiceImpl
All Implemented Interfaces:
IdentifiableBean, BaseService, LayoutService

public class LayoutServiceImpl
extends LayoutServiceBaseImpl

Provides the remote service for accessing, adding, deleting, exporting, importing, scheduling publishing of, and updating layouts. Its methods include permission checks.


Field Summary
 
Fields inherited from class com.liferay.portal.service.base.LayoutServiceBaseImpl
accountLocalService, accountPersistence, accountService, addressLocalService, addressPersistence, addressService, backgroundTaskLocalService, backgroundTaskPersistence, backgroundTaskService, browserTrackerLocalService, browserTrackerPersistence, classNameLocalService, classNamePersistence, classNameService, clusterGroupLocalService, clusterGroupPersistence, cmisRepositoryLocalService, companyLocalService, companyPersistence, companyService, contactLocalService, contactPersistence, contactService, counterLocalService, countryPersistence, countryService, emailAddressLocalService, emailAddressPersistence, emailAddressService, expandoRowLocalService, expandoRowPersistence, groupFinder, groupLocalService, groupPersistence, groupService, imageLocalService, imagePersistence, imageService, journalArticleFinder, journalArticleLocalService, journalArticlePersistence, journalArticleService, journalContentSearchLocalService, journalContentSearchPersistence, layoutBranchLocalService, layoutBranchPersistence, layoutBranchService, layoutFinder, layoutFriendlyURLLocalService, layoutFriendlyURLPersistence, layoutLocalService, layoutPersistence, layoutPrototypeLocalService, layoutPrototypePersistence, layoutPrototypeService, layoutRevisionLocalService, layoutRevisionPersistence, layoutRevisionService, layoutService, layoutSetBranchLocalService, layoutSetBranchPersistence, layoutSetBranchService, layoutSetLocalService, layoutSetPersistence, layoutSetPrototypeLocalService, layoutSetPrototypePersistence, layoutSetPrototypeService, layoutSetService, layoutTemplateLocalService, listTypePersistence, listTypeService, lockFinder, lockLocalService, lockPersistence, mbMessageFinder, mbMessageLocalService, mbMessagePersistence, mbMessageService, mdrRuleGroupInstanceLocalService, mdrRuleGroupInstancePersistence, mdrRuleGroupInstanceService, membershipRequestLocalService, membershipRequestPersistence, membershipRequestService, organizationFinder, organizationLocalService, organizationPersistence, organizationService, orgGroupRolePersistence, orgLaborLocalService, orgLaborPersistence, orgLaborService, passwordPolicyFinder, passwordPolicyLocalService, passwordPolicyPersistence, passwordPolicyRelLocalService, passwordPolicyRelPersistence, passwordPolicyService, passwordTrackerLocalService, passwordTrackerPersistence, permissionService, phoneLocalService, phonePersistence, phoneService, pluginSettingLocalService, pluginSettingPersistence, pluginSettingService, portalLocalService, portalPreferencesLocalService, portalPreferencesPersistence, portalService, portletItemLocalService, portletItemPersistence, portletLocalService, portletPersistence, portletPreferencesFinder, portletPreferencesLocalService, portletPreferencesPersistence, portletPreferencesService, portletService, quartzLocalService, ratingsStatsFinder, ratingsStatsLocalService, ratingsStatsPersistence, regionPersistence, regionService, releaseLocalService, releasePersistence, repositoryEntryLocalService, repositoryEntryPersistence, repositoryLocalService, repositoryPersistence, repositoryService, resourceActionLocalService, resourceActionPersistence, resourceBlockFinder, resourceBlockLocalService, resourceBlockPermissionLocalService, resourceBlockPermissionPersistence, resourceBlockPersistence, resourceBlockService, resourceLocalService, resourcePermissionFinder, resourcePermissionLocalService, resourcePermissionPersistence, resourcePermissionService, resourceTypePermissionFinder, resourceTypePermissionLocalService, resourceTypePermissionPersistence, roleFinder, roleLocalService, rolePersistence, roleService, serviceComponentLocalService, serviceComponentPersistence, shardLocalService, shardPersistence, stagingLocalService, stagingService, subscriptionLocalService, subscriptionPersistence, systemEventLocalService, systemEventPersistence, teamFinder, teamLocalService, teamPersistence, teamService, themeLocalService, themeService, ticketLocalService, ticketPersistence, userFinder, userGroupFinder, userGroupGroupRoleLocalService, userGroupGroupRolePersistence, userGroupGroupRoleService, userGroupLocalService, userGroupPersistence, userGroupRoleFinder, userGroupRoleLocalService, userGroupRolePersistence, userGroupRoleService, userGroupService, userIdMapperLocalService, userIdMapperPersistence, userLocalService, userNotificationDeliveryLocalService, userNotificationDeliveryPersistence, userNotificationEventLocalService, userNotificationEventPersistence, userPersistence, userService, userTrackerLocalService, userTrackerPathLocalService, userTrackerPathPersistence, userTrackerPersistence, virtualHostLocalService, virtualHostPersistence, webDAVPropsLocalService, webDAVPropsPersistence, websiteLocalService, websitePersistence, websiteService, workflowDefinitionLinkLocalService, workflowDefinitionLinkPersistence, workflowInstanceLinkLocalService, workflowInstanceLinkPersistence
 
Fields inherited from class com.liferay.portal.service.BaseServiceImpl
ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS
 
Constructor Summary
LayoutServiceImpl()
           
 
Method Summary
 Layout addLayout(long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext)
          Deprecated. As of 6.2.0, replaced by addLayout(long, boolean, long, Map, Map, Map, Map, Map, String, String, boolean, Map, ServiceContext)
 Layout addLayout(long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, String typeSettings, boolean hidden, Map<Locale,String> friendlyURLMap, ServiceContext serviceContext)
          Adds a layout with additional parameters.
 Layout addLayout(long groupId, boolean privateLayout, long parentLayoutId, String name, String title, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext)
          Adds a layout with single entry maps for name, title, and description to the default locale.
 FileEntry addTempFileEntry(long groupId, String fileName, String tempFolderName, InputStream inputStream, String mimeType)
           
 void deleteLayout(long groupId, boolean privateLayout, long layoutId, ServiceContext serviceContext)
          Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources.
 void deleteLayout(long plid, ServiceContext serviceContext)
          Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.
 void deleteTempFileEntry(long groupId, String fileName, String tempFolderName)
           
 byte[] exportLayouts(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate)
          Exports the layouts that match the primary keys and the criteria as a byte array.
 byte[] exportLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, Date startDate, Date endDate)
          Exports all layouts that match the criteria as a byte array.
 File exportLayoutsAsFile(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate)
          Exports all layouts that match the primary keys and criteria as a file.
 long exportLayoutsAsFileInBackground(String taskName, long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate, String fileName)
           
 byte[] exportPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)
          Exports the portlet information (categories, permissions, ... etc.) as a byte array.
 byte[] exportPortletInfo(long companyId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)
           
 File exportPortletInfoAsFile(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)
          Exports the portlet information (categories, permissions, ... etc.) as a file.
 File exportPortletInfoAsFile(String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)
           
 long exportPortletInfoAsFileInBackground(String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate, String fileName)
           
 long exportPortletInfoAsFileInBackground(String taskName, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate, String fileName)
           
protected  List<Layout> filterLayouts(List<Layout> layouts)
           
 List<Layout> getAncestorLayouts(long plid)
          Returns all the ancestor layouts of the layout.
 long getDefaultPlid(long groupId, long scopeGroupId, boolean privateLayout, String portletId)
          Returns the primary key of the default layout for the group.
 long getDefaultPlid(long groupId, long scopeGroupId, String portletId)
           
 Layout getLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout)
          Returns the layout matching the UUID, group, and privacy.
 String getLayoutName(long groupId, boolean privateLayout, long layoutId, String languageId)
          Returns the name of the layout.
 LayoutReference[] getLayoutReferences(long companyId, String portletId, String preferencesKey, String preferencesValue)
          Returns the layout references for all the layouts that belong to the company and belong to the portlet that matches the preferences.
 List<Layout> getLayouts(long groupId, boolean privateLayout)
           
 List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId)
           
 List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end)
           
 int getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId)
           
 String[] getTempFileEntryNames(long groupId, String tempFolderName)
           
 void importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, byte[] bytes)
          Imports the layouts from the byte array.
 void importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)
          Imports the layouts from the file.
 void importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is)
          Imports the layouts from the input stream.
 long importLayoutsInBackground(String taskName, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)
           
 long importLayoutsInBackground(String taskName, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream inputStream)
           
 void importPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file)
          Imports the portlet information (categories, permissions, ... etc.) from the file.
 void importPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is)
          Imports the portlet information (categories, permissions, ... etc.) from the input stream.
 void importPortletInfo(String portletId, Map<String,String[]> parameterMap, File file)
           
 void importPortletInfo(String portletId, Map<String,String[]> parameterMap, InputStream is)
           
 long importPortletInfoInBackground(String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file)
           
 long importPortletInfoInBackground(String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is)
           
 void importPortletInfoInBackground(String taskName, String portletId, Map<String,String[]> parameterMap, File file)
           
 void importPortletInfoInBackground(String taskName, String portletId, Map<String,String[]> parameterMap, InputStream is)
           
 void schedulePublishToLive(long sourceGroupId, long targetGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String scope, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description)
          Schedules a range of layouts to be published.
 void schedulePublishToRemote(long sourceGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description)
          Schedules a range of layouts to be stored.
 void setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds, ServiceContext serviceContext)
          Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout.
 void unschedulePublishToLive(long groupId, String jobName, String groupName)
          Deletes the job from the scheduler's queue.
 void unschedulePublishToRemote(long groupId, String jobName, String groupName)
          Deletes the job from the scheduler's persistent queue.
 Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, boolean hidden, Map<Locale,String> friendlyURLMap, Boolean iconImage, byte[] iconBytes, ServiceContext serviceContext)
          Updates the layout with additional parameters.
 Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, boolean hidden, String friendlyURL, Boolean iconImage, byte[] iconBytes, ServiceContext serviceContext)
          Deprecated. As of 6.2.0, replaced by updateLayout(long, boolean, long, long, Map, Map, Map, Map, Map, String, boolean, Map, Boolean, byte[], ServiceContext)
 Layout updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings)
          Updates the layout replacing its type settings.
 Layout updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css, boolean wapTheme)
          Updates the look and feel of the layout.
 Layout updateName(long groupId, boolean privateLayout, long layoutId, String name, String languageId)
          Updates the name of the layout matching the group, layout ID, and privacy.
 Layout updateName(long plid, String name, String languageId)
          Updates the name of the layout matching the primary key.
 Layout updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId)
          Updates the parent layout ID of the layout matching the group, layout ID, and privacy.
 Layout updateParentLayoutId(long plid, long parentPlid)
          Updates the parent layout ID of the layout matching the primary key.
 Layout updateParentLayoutIdAndPriority(long plid, long parentPlid, int priority)
           
 Layout updatePriority(long groupId, boolean privateLayout, long layoutId, int priority)
          Updates the priority of the layout matching the group, layout ID, and privacy.
 Layout updatePriority(long groupId, boolean privateLayout, long layoutId, long nextLayoutId, long previousLayoutId)
          Updates the priority of the layout matching the group, layout ID, and privacy, setting the layout's priority based on the priorities of the next and previous layouts.
 Layout updatePriority(long plid, int priority)
          Updates the priority of the layout matching the primary key.
 MissingReferences validateImportLayoutsFile(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)
           
 MissingReferences validateImportLayoutsFile(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream inputStream)
           
 MissingReferences validateImportPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file)
           
 MissingReferences validateImportPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream inputStream)
           
 
Methods inherited from class com.liferay.portal.service.base.LayoutServiceBaseImpl
afterPropertiesSet, destroy, getAccountLocalService, getAccountPersistence, getAccountService, getAddressLocalService, getAddressPersistence, getAddressService, getBackgroundTaskLocalService, getBackgroundTaskPersistence, getBackgroundTaskService, getBeanIdentifier, getBrowserTrackerLocalService, getBrowserTrackerPersistence, getClassNameLocalService, getClassNamePersistence, getClassNameService, getClusterGroupLocalService, getClusterGroupPersistence, getCMISRepositoryLocalService, getCompanyLocalService, getCompanyPersistence, getCompanyService, getContactLocalService, getContactPersistence, getContactService, getCounterLocalService, getCountryPersistence, getCountryService, getEmailAddressLocalService, getEmailAddressPersistence, getEmailAddressService, getExpandoRowLocalService, getExpandoRowPersistence, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroupService, getImageLocalService, getImagePersistence, getImageService, getJournalArticleFinder, getJournalArticleLocalService, getJournalArticlePersistence, getJournalArticleService, getJournalContentSearchLocalService, getJournalContentSearchPersistence, getLayoutBranchLocalService, getLayoutBranchPersistence, getLayoutBranchService, getLayoutFinder, getLayoutFriendlyURLLocalService, getLayoutFriendlyURLPersistence, getLayoutLocalService, getLayoutPersistence, getLayoutPrototypeLocalService, getLayoutPrototypePersistence, getLayoutPrototypeService, getLayoutRevisionLocalService, getLayoutRevisionPersistence, getLayoutRevisionService, getLayoutService, getLayoutSetBranchLocalService, getLayoutSetBranchPersistence, getLayoutSetBranchService, getLayoutSetLocalService, getLayoutSetPersistence, getLayoutSetPrototypeLocalService, getLayoutSetPrototypePersistence, getLayoutSetPrototypeService, getLayoutSetService, getLayoutTemplateLocalService, getListTypePersistence, getListTypeService, getLockFinder, getLockLocalService, getLockPersistence, getMBMessageFinder, getMBMessageLocalService, getMBMessagePersistence, getMBMessageService, getMDRRuleGroupInstanceLocalService, getMDRRuleGroupInstancePersistence, getMDRRuleGroupInstanceService, getMembershipRequestLocalService, getMembershipRequestPersistence, getMembershipRequestService, getModelClass, getModelClassName, getOrganizationFinder, getOrganizationLocalService, getOrganizationPersistence, getOrganizationService, getOrgGroupRolePersistence, getOrgLaborLocalService, getOrgLaborPersistence, getOrgLaborService, getPasswordPolicyFinder, getPasswordPolicyLocalService, getPasswordPolicyPersistence, getPasswordPolicyRelLocalService, getPasswordPolicyRelPersistence, getPasswordPolicyService, getPasswordTrackerLocalService, getPasswordTrackerPersistence, getPermissionService, getPhoneLocalService, getPhonePersistence, getPhoneService, getPluginSettingLocalService, getPluginSettingPersistence, getPluginSettingService, getPortalLocalService, getPortalPreferencesLocalService, getPortalPreferencesPersistence, getPortalService, getPortletItemLocalService, getPortletItemPersistence, getPortletLocalService, getPortletPersistence, getPortletPreferencesFinder, getPortletPreferencesLocalService, getPortletPreferencesPersistence, getPortletPreferencesService, getPortletService, getQuartzLocalService, getRatingsStatsFinder, getRatingsStatsLocalService, getRatingsStatsPersistence, getRegionPersistence, getRegionService, getReleaseLocalService, getReleasePersistence, getRepositoryEntryLocalService, getRepositoryEntryPersistence, getRepositoryLocalService, getRepositoryPersistence, getRepositoryService, getResourceActionLocalService, getResourceActionPersistence, getResourceBlockFinder, getResourceBlockLocalService, getResourceBlockPermissionLocalService, getResourceBlockPermissionPersistence, getResourceBlockPersistence, getResourceBlockService, getResourceLocalService, getResourcePermissionFinder, getResourcePermissionLocalService, getResourcePermissionPersistence, getResourcePermissionService, getResourceTypePermissionFinder, getResourceTypePermissionLocalService, getResourceTypePermissionPersistence, getRoleFinder, getRoleLocalService, getRolePersistence, getRoleService, getServiceComponentLocalService, getServiceComponentPersistence, getShardLocalService, getShardPersistence, getStagingLocalService, getStagingService, getSubscriptionLocalService, getSubscriptionPersistence, getSystemEventLocalService, getSystemEventPersistence, getTeamFinder, getTeamLocalService, getTeamPersistence, getTeamService, getThemeLocalService, getThemeService, getTicketLocalService, getTicketPersistence, getUserFinder, getUserGroupFinder, getUserGroupGroupRoleLocalService, getUserGroupGroupRolePersistence, getUserGroupGroupRoleService, getUserGroupLocalService, getUserGroupPersistence, getUserGroupRoleFinder, getUserGroupRoleLocalService, getUserGroupRolePersistence, getUserGroupRoleService, getUserGroupService, getUserIdMapperLocalService, getUserIdMapperPersistence, getUserLocalService, getUserNotificationDeliveryLocalService, getUserNotificationDeliveryPersistence, getUserNotificationEventLocalService, getUserNotificationEventPersistence, getUserPersistence, getUserService, getUserTrackerLocalService, getUserTrackerPathLocalService, getUserTrackerPathPersistence, getUserTrackerPersistence, getVirtualHostLocalService, getVirtualHostPersistence, getWebDAVPropsLocalService, getWebDAVPropsPersistence, getWebsiteLocalService, getWebsitePersistence, getWebsiteService, getWorkflowDefinitionLinkLocalService, getWorkflowDefinitionLinkPersistence, getWorkflowInstanceLinkLocalService, getWorkflowInstanceLinkPersistence, runSQL, setAccountLocalService, setAccountPersistence, setAccountService, setAddressLocalService, setAddressPersistence, setAddressService, setBackgroundTaskLocalService, setBackgroundTaskPersistence, setBackgroundTaskService, setBeanIdentifier, setBrowserTrackerLocalService, setBrowserTrackerPersistence, setClassNameLocalService, setClassNamePersistence, setClassNameService, setClusterGroupLocalService, setClusterGroupPersistence, setCMISRepositoryLocalService, setCompanyLocalService, setCompanyPersistence, setCompanyService, setContactLocalService, setContactPersistence, setContactService, setCounterLocalService, setCountryPersistence, setCountryService, setEmailAddressLocalService, setEmailAddressPersistence, setEmailAddressService, setExpandoRowLocalService, setExpandoRowPersistence, setGroupFinder, setGroupLocalService, setGroupPersistence, setGroupService, setImageLocalService, setImagePersistence, setImageService, setJournalArticleFinder, setJournalArticleLocalService, setJournalArticlePersistence, setJournalArticleService, setJournalContentSearchLocalService, setJournalContentSearchPersistence, setLayoutBranchLocalService, setLayoutBranchPersistence, setLayoutBranchService, setLayoutFinder, setLayoutFriendlyURLLocalService, setLayoutFriendlyURLPersistence, setLayoutLocalService, setLayoutPersistence, setLayoutPrototypeLocalService, setLayoutPrototypePersistence, setLayoutPrototypeService, setLayoutRevisionLocalService, setLayoutRevisionPersistence, setLayoutRevisionService, setLayoutService, setLayoutSetBranchLocalService, setLayoutSetBranchPersistence, setLayoutSetBranchService, setLayoutSetLocalService, setLayoutSetPersistence, setLayoutSetPrototypeLocalService, setLayoutSetPrototypePersistence, setLayoutSetPrototypeService, setLayoutSetService, setLayoutTemplateLocalService, setListTypePersistence, setListTypeService, setLockFinder, setLockLocalService, setLockPersistence, setMBMessageFinder, setMBMessageLocalService, setMBMessagePersistence, setMBMessageService, setMDRRuleGroupInstanceLocalService, setMDRRuleGroupInstancePersistence, setMDRRuleGroupInstanceService, setMembershipRequestLocalService, setMembershipRequestPersistence, setMembershipRequestService, setOrganizationFinder, setOrganizationLocalService, setOrganizationPersistence, setOrganizationService, setOrgGroupRolePersistence, setOrgLaborLocalService, setOrgLaborPersistence, setOrgLaborService, setPasswordPolicyFinder, setPasswordPolicyLocalService, setPasswordPolicyPersistence, setPasswordPolicyRelLocalService, setPasswordPolicyRelPersistence, setPasswordPolicyService, setPasswordTrackerLocalService, setPasswordTrackerPersistence, setPermissionService, setPhoneLocalService, setPhonePersistence, setPhoneService, setPluginSettingLocalService, setPluginSettingPersistence, setPluginSettingService, setPortalLocalService, setPortalPreferencesLocalService, setPortalPreferencesPersistence, setPortalService, setPortletItemLocalService, setPortletItemPersistence, setPortletLocalService, setPortletPersistence, setPortletPreferencesFinder, setPortletPreferencesLocalService, setPortletPreferencesPersistence, setPortletPreferencesService, setPortletService, setQuartzLocalService, setRatingsStatsFinder, setRatingsStatsLocalService, setRatingsStatsPersistence, setRegionPersistence, setRegionService, setReleaseLocalService, setReleasePersistence, setRepositoryEntryLocalService, setRepositoryEntryPersistence, setRepositoryLocalService, setRepositoryPersistence, setRepositoryService, setResourceActionLocalService, setResourceActionPersistence, setResourceBlockFinder, setResourceBlockLocalService, setResourceBlockPermissionLocalService, setResourceBlockPermissionPersistence, setResourceBlockPersistence, setResourceBlockService, setResourceLocalService, setResourcePermissionFinder, setResourcePermissionLocalService, setResourcePermissionPersistence, setResourcePermissionService, setResourceTypePermissionFinder, setResourceTypePermissionLocalService, setResourceTypePermissionPersistence, setRoleFinder, setRoleLocalService, setRolePersistence, setRoleService, setServiceComponentLocalService, setServiceComponentPersistence, setShardLocalService, setShardPersistence, setStagingLocalService, setStagingService, setSubscriptionLocalService, setSubscriptionPersistence, setSystemEventLocalService, setSystemEventPersistence, setTeamFinder, setTeamLocalService, setTeamPersistence, setTeamService, setThemeLocalService, setThemeService, setTicketLocalService, setTicketPersistence, setUserFinder, setUserGroupFinder, setUserGroupGroupRoleLocalService, setUserGroupGroupRolePersistence, setUserGroupGroupRoleService, setUserGroupLocalService, setUserGroupPersistence, setUserGroupRoleFinder, setUserGroupRoleLocalService, setUserGroupRolePersistence, setUserGroupRoleService, setUserGroupService, setUserIdMapperLocalService, setUserIdMapperPersistence, setUserLocalService, setUserNotificationDeliveryLocalService, setUserNotificationDeliveryPersistence, setUserNotificationEventLocalService, setUserNotificationEventPersistence, setUserPersistence, setUserService, setUserTrackerLocalService, setUserTrackerPathLocalService, setUserTrackerPathPersistence, setUserTrackerPersistence, setVirtualHostLocalService, setVirtualHostPersistence, setWebDAVPropsLocalService, setWebDAVPropsPersistence, setWebsiteLocalService, setWebsitePersistence, setWebsiteService, setWorkflowDefinitionLinkLocalService, setWorkflowDefinitionLinkPersistence, setWorkflowInstanceLinkLocalService, setWorkflowInstanceLinkPersistence
 
Methods inherited from class com.liferay.portal.service.BaseServiceImpl
getClassLoader, getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LayoutServiceImpl

public LayoutServiceImpl()
Method Detail

addLayout

public Layout addLayout(long groupId,
                        boolean privateLayout,
                        long parentLayoutId,
                        Map<Locale,String> localeNamesMap,
                        Map<Locale,String> localeTitlesMap,
                        Map<Locale,String> descriptionMap,
                        Map<Locale,String> keywordsMap,
                        Map<Locale,String> robotsMap,
                        String type,
                        boolean hidden,
                        String friendlyURL,
                        ServiceContext serviceContext)
                 throws PortalException,
                        SystemException
Deprecated. As of 6.2.0, replaced by addLayout(long, boolean, long, Map, Map, Map, Map, Map, String, String, boolean, Map, ServiceContext)

Adds a layout with additional parameters.

This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parentLayoutId - the primary key of the parent layout (optionally LayoutConstants.DEFAULT_PARENT_LAYOUT_ID)
localeNamesMap - the layout's locales and localized names
localeTitlesMap - the layout's locales and localized titles
descriptionMap - the layout's locales and localized descriptions
keywordsMap - the layout's locales and localized keywords
robotsMap - the layout's locales and localized robots
type - the layout's type (optionally LayoutConstants.TYPE_PORTLET). The possible types can be found in LayoutConstants.
hidden - whether the layout is hidden
friendlyURL - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize( String).
serviceContext - the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be used to specify whether site administrators can modify this page within their site.
Returns:
the layout
Throws:
PortalException - if a group with the primary key could not be found, if the group did not have permission to manage the layouts involved, if layout values were invalid, or if a portal exception occurred
SystemException - if a system exception occurred

addLayout

public Layout addLayout(long groupId,
                        boolean privateLayout,
                        long parentLayoutId,
                        Map<Locale,String> localeNamesMap,
                        Map<Locale,String> localeTitlesMap,
                        Map<Locale,String> descriptionMap,
                        Map<Locale,String> keywordsMap,
                        Map<Locale,String> robotsMap,
                        String type,
                        String typeSettings,
                        boolean hidden,
                        Map<Locale,String> friendlyURLMap,
                        ServiceContext serviceContext)
                 throws PortalException,
                        SystemException
Adds a layout with additional parameters.

This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parentLayoutId - the primary key of the parent layout (optionally LayoutConstants.DEFAULT_PARENT_LAYOUT_ID)
localeNamesMap - the layout's locales and localized names
localeTitlesMap - the layout's locales and localized titles
descriptionMap - the layout's locales and localized descriptions
keywordsMap - the layout's locales and localized keywords
robotsMap - the layout's locales and localized robots
type - the layout's type (optionally LayoutConstants.TYPE_PORTLET). The possible types can be found in LayoutConstants.
typeSettings - the settings to load the unicode properties object. See #fastLoad(String).
hidden - whether the layout is hidden
friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize( String).
serviceContext - the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be used to specify whether site administrators can modify this page within their site.
Returns:
the layout
Throws:
PortalException - if a group with the primary key could not be found, if the group did not have permission to manage the layouts involved, if layout values were invalid, or if a portal exception occurred
SystemException - if a system exception occurred

addLayout

public Layout addLayout(long groupId,
                        boolean privateLayout,
                        long parentLayoutId,
                        String name,
                        String title,
                        String description,
                        String type,
                        boolean hidden,
                        String friendlyURL,
                        ServiceContext serviceContext)
                 throws PortalException,
                        SystemException
Adds a layout with single entry maps for name, title, and description to the default locale.

This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parentLayoutId - the primary key of the parent layout (optionally LayoutConstants.DEFAULT_PARENT_LAYOUT_ID)
name - Map the layout's locales and localized names
title - Map the layout's locales and localized titles
description - Map the layout's locales and localized descriptions
type - the layout's type (optionally LayoutConstants.TYPE_PORTLET). The possible types can be found in LayoutConstants.
hidden - whether the layout is hidden
friendlyURL - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize( String).
serviceContext - the service context to be applied. Must set the UUID for the layout. Can specify the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be used to specify whether site administrators can modify this page within their site.
Returns:
the layout
Throws:
PortalException - if a group with the primary key could not be found, if the group did not have permission to manage the layouts involved, if layout values were invalid, or if a portal exception occurred
SystemException - if a system exception occurred

addTempFileEntry

public FileEntry addTempFileEntry(long groupId,
                                  String fileName,
                                  String tempFolderName,
                                  InputStream inputStream,
                                  String mimeType)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

deleteLayout

public void deleteLayout(long groupId,
                         boolean privateLayout,
                         long layoutId,
                         ServiceContext serviceContext)
                  throws PortalException,
                         SystemException
Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
serviceContext - the service context to be applied
Throws:
PortalException - if the user did not have permission to delete the layout, if a matching layout could not be found , or if some other portal exception occurred
SystemException - if a system exception occurred

deleteLayout

public void deleteLayout(long plid,
                         ServiceContext serviceContext)
                  throws PortalException,
                         SystemException
Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.

Parameters:
plid - the primary key of the layout
serviceContext - the service context to be applied
Throws:
PortalException - if the user did not have permission to delete the layout, if a layout with the primary key could not be found , or if some other portal exception occurred
SystemException - if a system exception occurred

deleteTempFileEntry

public void deleteTempFileEntry(long groupId,
                                String fileName,
                                String tempFolderName)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

exportLayouts

public byte[] exportLayouts(long groupId,
                            boolean privateLayout,
                            long[] layoutIds,
                            Map<String,String[]> parameterMap,
                            Date startDate,
                            Date endDate)
                     throws PortalException,
                            SystemException
Exports the layouts that match the primary keys and the criteria as a byte array.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutIds - the primary keys of the layouts to be exported
parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
startDate - the export's start date
endDate - the export's end date
Returns:
the layouts as a byte array
Throws:
PortalException - if a group or any layout with the primary key could not be found, if the group did not have permission to manage the layouts, or if some other portal exception occurred
SystemException - if a system exception occurred

exportLayouts

public byte[] exportLayouts(long groupId,
                            boolean privateLayout,
                            Map<String,String[]> parameterMap,
                            Date startDate,
                            Date endDate)
                     throws PortalException,
                            SystemException
Exports all layouts that match the criteria as a byte array.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
startDate - the export's start date
endDate - the export's end date
Returns:
the layout as a byte array
Throws:
PortalException - if a group with the primary key could not be found, if the group did not have permission to manage the layouts, or if some other portal exception occurred
SystemException - if a system exception occurred

exportLayoutsAsFile

public File exportLayoutsAsFile(long groupId,
                                boolean privateLayout,
                                long[] layoutIds,
                                Map<String,String[]> parameterMap,
                                Date startDate,
                                Date endDate)
                         throws PortalException,
                                SystemException
Exports all layouts that match the primary keys and criteria as a file.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutIds - the primary keys of the layouts to be exported (optionally null)
parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
startDate - the export's start date
endDate - the export's end date
Returns:
the layouts as a File
Throws:
PortalException - if a group or any layout with the primary key could not be found, it the group did not have permission to manage the layouts, or if some other portal exception occurred
SystemException - if a system exception occurred

exportLayoutsAsFileInBackground

public long exportLayoutsAsFileInBackground(String taskName,
                                            long groupId,
                                            boolean privateLayout,
                                            long[] layoutIds,
                                            Map<String,String[]> parameterMap,
                                            Date startDate,
                                            Date endDate,
                                            String fileName)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

exportPortletInfo

public byte[] exportPortletInfo(long plid,
                                long groupId,
                                String portletId,
                                Map<String,String[]> parameterMap,
                                Date startDate,
                                Date endDate)
                         throws PortalException,
                                SystemException
Exports the portlet information (categories, permissions, ... etc.) as a byte array.

Parameters:
plid - the primary key of the layout
groupId - the primary key of the group
portletId - the primary key of the portlet
parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
startDate - the export's start date
endDate - the export's end date
Returns:
the portlet information as a byte array
Throws:
PortalException - if a layout, group, or portlet with the primary key could not be found, if the group did not have permission to manage the layouts involved, or if some other portal exception occurred
SystemException - if a system exception occurred

exportPortletInfo

public byte[] exportPortletInfo(long companyId,
                                String portletId,
                                Map<String,String[]> parameterMap,
                                Date startDate,
                                Date endDate)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

exportPortletInfoAsFile

public File exportPortletInfoAsFile(long plid,
                                    long groupId,
                                    String portletId,
                                    Map<String,String[]> parameterMap,
                                    Date startDate,
                                    Date endDate)
                             throws PortalException,
                                    SystemException
Exports the portlet information (categories, permissions, ... etc.) as a file.

Parameters:
plid - the primary key of the layout
groupId - the primary key of the group
portletId - the primary key of the portlet
parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
startDate - the export's start date
endDate - the export's end date
Returns:
the portlet information as a file
Throws:
PortalException - if a layout, group, or portlet with the primary key could not be found, it the group did not have permission to manage the layouts involved, or if some other portal exception occurred
SystemException - if a system exception occurred

exportPortletInfoAsFile

public File exportPortletInfoAsFile(String portletId,
                                    Map<String,String[]> parameterMap,
                                    Date startDate,
                                    Date endDate)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

exportPortletInfoAsFileInBackground

public long exportPortletInfoAsFileInBackground(String taskName,
                                                long plid,
                                                long groupId,
                                                String portletId,
                                                Map<String,String[]> parameterMap,
                                                Date startDate,
                                                Date endDate,
                                                String fileName)
                                         throws PortalException,
                                                SystemException
Throws:
PortalException
SystemException

exportPortletInfoAsFileInBackground

public long exportPortletInfoAsFileInBackground(String taskName,
                                                String portletId,
                                                Map<String,String[]> parameterMap,
                                                Date startDate,
                                                Date endDate,
                                                String fileName)
                                         throws PortalException,
                                                SystemException
Throws:
PortalException
SystemException

getAncestorLayouts

public List<Layout> getAncestorLayouts(long plid)
                                throws PortalException,
                                       SystemException
Returns all the ancestor layouts of the layout.

Parameters:
plid - the primary key of the layout
Returns:
the ancestor layouts of the layout
Throws:
PortalException - if a matching layout could not be found or if a portal exception occurred
SystemException - if a system exception occurred

getDefaultPlid

public long getDefaultPlid(long groupId,
                           long scopeGroupId,
                           boolean privateLayout,
                           String portletId)
                    throws PortalException,
                           SystemException
Returns the primary key of the default layout for the group.

Parameters:
groupId - the primary key of the group
scopeGroupId - the primary key of the scope group. See ServiceContext.getScopeGroupId().
privateLayout - whether the layout is private to the group
portletId - the primary key of the portlet
Returns:
Returns the primary key of the default layout group; LayoutConstants.DEFAULT_PLID otherwise
Throws:
PortalException - if a group, layout, or portlet with the primary key could not be found
SystemException - if a system exception occurred

getDefaultPlid

@ThreadLocalCachable
public long getDefaultPlid(long groupId,
                                               long scopeGroupId,
                                               String portletId)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

getLayoutByUuidAndGroupId

public Layout getLayoutByUuidAndGroupId(String uuid,
                                        long groupId,
                                        boolean privateLayout)
                                 throws PortalException,
                                        SystemException
Returns the layout matching the UUID, group, and privacy.

Parameters:
uuid - the layout's UUID
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
Returns:
the matching layout
Throws:
PortalException - if a matching layout could not be found, if the user did not have permission to view the layout, or if some other portal exception occurred
SystemException - if a system exception occurred

getLayoutName

public String getLayoutName(long groupId,
                            boolean privateLayout,
                            long layoutId,
                            String languageId)
                     throws PortalException,
                            SystemException
Returns the name of the layout.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
languageId - the primary key of the language. For more information See Locale.
Returns:
the layout's name
Throws:
PortalException - if a matching layout could not be found
SystemException - if a system exception occurred

getLayoutReferences

public LayoutReference[] getLayoutReferences(long companyId,
                                             String portletId,
                                             String preferencesKey,
                                             String preferencesValue)
                                      throws SystemException
Returns the layout references for all the layouts that belong to the company and belong to the portlet that matches the preferences.

Parameters:
companyId - the primary key of the company
portletId - the primary key of the portlet
preferencesKey - the portlet's preference key
preferencesValue - the portlet's preference value
Returns:
the layout references of the matching layouts
Throws:
SystemException - if a system exception occurred

getLayouts

public List<Layout> getLayouts(long groupId,
                               boolean privateLayout)
                        throws SystemException
Throws:
SystemException

getLayouts

public List<Layout> getLayouts(long groupId,
                               boolean privateLayout,
                               long parentLayoutId)
                        throws SystemException
Throws:
SystemException

getLayouts

public List<Layout> getLayouts(long groupId,
                               boolean privateLayout,
                               long parentLayoutId,
                               boolean incomplete,
                               int start,
                               int end)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

getLayoutsCount

public int getLayoutsCount(long groupId,
                           boolean privateLayout,
                           long parentLayoutId)
                    throws SystemException
Throws:
SystemException

getTempFileEntryNames

public String[] getTempFileEntryNames(long groupId,
                                      String tempFolderName)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

importLayouts

public void importLayouts(long groupId,
                          boolean privateLayout,
                          Map<String,String[]> parameterMap,
                          byte[] bytes)
                   throws PortalException,
                          SystemException
Imports the layouts from the byte array.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
bytes - the byte array with the data
Throws:
PortalException - if a group with the primary key could not be found, if the group did not have permission to manage the layouts, or if some other portal exception occurred
SystemException - if a system exception occurred
See Also:
LayoutImporter

importLayouts

public void importLayouts(long groupId,
                          boolean privateLayout,
                          Map<String,String[]> parameterMap,
                          File file)
                   throws PortalException,
                          SystemException
Imports the layouts from the file.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
file - the LAR file with the data
Throws:
PortalException - if a group with the primary key could not be found, if the group did not have permission to manage the layouts and publish, or if some other portal exception occurred
SystemException - if a system exception occurred
See Also:
LayoutImporter

importLayouts

public void importLayouts(long groupId,
                          boolean privateLayout,
                          Map<String,String[]> parameterMap,
                          InputStream is)
                   throws PortalException,
                          SystemException
Imports the layouts from the input stream.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
is - the input stream
Throws:
PortalException - if a group with the primary key could not be found, if the group did not have permission to manage the layouts, or if some other portal exception occurred
SystemException - if a system exception occurred
See Also:
LayoutImporter

importLayoutsInBackground

public long importLayoutsInBackground(String taskName,
                                      long groupId,
                                      boolean privateLayout,
                                      Map<String,String[]> parameterMap,
                                      File file)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

importLayoutsInBackground

public long importLayoutsInBackground(String taskName,
                                      long groupId,
                                      boolean privateLayout,
                                      Map<String,String[]> parameterMap,
                                      InputStream inputStream)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

importPortletInfo

public void importPortletInfo(long plid,
                              long groupId,
                              String portletId,
                              Map<String,String[]> parameterMap,
                              File file)
                       throws PortalException,
                              SystemException
Imports the portlet information (categories, permissions, ... etc.) from the file.

Parameters:
plid - the primary key of the layout
groupId - the primary key of the group
portletId - the primary key of the portlet
parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
file - the LAR file with the data
Throws:
PortalException - if a group, layout, or portlet with the primary key could not be found, or if the group did not have permission to manage the layouts
SystemException - if a system exception occurred

importPortletInfo

public void importPortletInfo(long plid,
                              long groupId,
                              String portletId,
                              Map<String,String[]> parameterMap,
                              InputStream is)
                       throws PortalException,
                              SystemException
Imports the portlet information (categories, permissions, ... etc.) from the input stream.

Parameters:
plid - the primary key of the layout
groupId - the primary key of the group
portletId - the primary key of the portlet
parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
is - the input stream
Throws:
PortalException - if a group, portlet, or layout with the primary key could not be found or if the group did not have permission to manage the layouts
SystemException - if a system exception occurred

importPortletInfo

public void importPortletInfo(String portletId,
                              Map<String,String[]> parameterMap,
                              File file)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

importPortletInfo

public void importPortletInfo(String portletId,
                              Map<String,String[]> parameterMap,
                              InputStream is)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

importPortletInfoInBackground

public long importPortletInfoInBackground(String taskName,
                                          long plid,
                                          long groupId,
                                          String portletId,
                                          Map<String,String[]> parameterMap,
                                          File file)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

importPortletInfoInBackground

public long importPortletInfoInBackground(String taskName,
                                          long plid,
                                          long groupId,
                                          String portletId,
                                          Map<String,String[]> parameterMap,
                                          InputStream is)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

importPortletInfoInBackground

public void importPortletInfoInBackground(String taskName,
                                          String portletId,
                                          Map<String,String[]> parameterMap,
                                          File file)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

importPortletInfoInBackground

public void importPortletInfoInBackground(String taskName,
                                          String portletId,
                                          Map<String,String[]> parameterMap,
                                          InputStream is)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

schedulePublishToLive

public void schedulePublishToLive(long sourceGroupId,
                                  long targetGroupId,
                                  boolean privateLayout,
                                  Map<Long,Boolean> layoutIdMap,
                                  Map<String,String[]> parameterMap,
                                  String scope,
                                  Date startDate,
                                  Date endDate,
                                  String groupName,
                                  String cronText,
                                  Date schedulerStartDate,
                                  Date schedulerEndDate,
                                  String description)
                           throws PortalException,
                                  SystemException
Schedules a range of layouts to be published.

Parameters:
sourceGroupId - the primary key of the source group
targetGroupId - the primary key of the target group
privateLayout - whether the layout is private to the group
layoutIdMap - the layouts considered for publishing, specified by the layout IDs and booleans indicating whether they have children
parameterMap - the mapping of parameters indicating which information will be used. See PortletDataHandlerKeys
scope - the scope of the pages. It can be all-pages or selected-pages.
startDate - the start date
endDate - the end date
groupName - the group name (optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
cronText - the cron text. See #toCronText
schedulerStartDate - the scheduler start date
schedulerEndDate - the scheduler end date
description - the scheduler description
Throws:
PortalException - if the group did not have permission to manage and publish
SystemException - if a system exception occurred

schedulePublishToRemote

public void schedulePublishToRemote(long sourceGroupId,
                                    boolean privateLayout,
                                    Map<Long,Boolean> layoutIdMap,
                                    Map<String,String[]> parameterMap,
                                    String remoteAddress,
                                    int remotePort,
                                    String remotePathContext,
                                    boolean secureConnection,
                                    long remoteGroupId,
                                    boolean remotePrivateLayout,
                                    Date startDate,
                                    Date endDate,
                                    String groupName,
                                    String cronText,
                                    Date schedulerStartDate,
                                    Date schedulerEndDate,
                                    String description)
                             throws PortalException,
                                    SystemException
Schedules a range of layouts to be stored.

Parameters:
sourceGroupId - the primary key of the source group
privateLayout - whether the layout is private to the group
layoutIdMap - the layouts considered for publishing, specified by the layout IDs and booleans indicating whether they have children
parameterMap - the mapping of parameters indicating which information will be used. See PortletDataHandlerKeys
remoteAddress - the remote address
remotePort - the remote port
remotePathContext - the remote path context
secureConnection - whether the connection is secure
remoteGroupId - the primary key of the remote group
remotePrivateLayout - whether remote group's layout is private
startDate - the start date
endDate - the end date
groupName - the group name. Optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
cronText - the cron text. See #toCronText
schedulerStartDate - the scheduler start date
schedulerEndDate - the scheduler end date
description - the scheduler description
Throws:
PortalException - if a group with the source group primary key was not found or if the group did not have permission to publish
SystemException - if a system exception occurred

setLayouts

public void setLayouts(long groupId,
                       boolean privateLayout,
                       long parentLayoutId,
                       long[] layoutIds,
                       ServiceContext serviceContext)
                throws PortalException,
                       SystemException
Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
parentLayoutId - the primary key of the parent layout
layoutIds - the primary keys of the layouts
serviceContext - the service context to be applied
Throws:
PortalException - if a group or layout with the primary key could not be found, if the group did not have permission to manage the layouts, if no layouts were specified, if the first layout was not page-able, if the first layout was hidden, or if some other portal exception occurred
SystemException - if a system exception occurred

unschedulePublishToLive

public void unschedulePublishToLive(long groupId,
                                    String jobName,
                                    String groupName)
                             throws PortalException,
                                    SystemException
Deletes the job from the scheduler's queue.

Parameters:
groupId - the primary key of the group
jobName - the job name
groupName - the group name (optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
Throws:
PortalException - if the group did not permission to manage staging and publish
SystemException - if a system exception occurred

unschedulePublishToRemote

public void unschedulePublishToRemote(long groupId,
                                      String jobName,
                                      String groupName)
                               throws PortalException,
                                      SystemException
Deletes the job from the scheduler's persistent queue.

Parameters:
groupId - the primary key of the group
jobName - the job name
groupName - the group name (optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
Throws:
PortalException - if a group with the primary key could not be found or if the group did not have permission to publish
SystemException - if a system exception occurred

updateLayout

public Layout updateLayout(long groupId,
                           boolean privateLayout,
                           long layoutId,
                           long parentLayoutId,
                           Map<Locale,String> localeNamesMap,
                           Map<Locale,String> localeTitlesMap,
                           Map<Locale,String> descriptionMap,
                           Map<Locale,String> keywordsMap,
                           Map<Locale,String> robotsMap,
                           String type,
                           boolean hidden,
                           Map<Locale,String> friendlyURLMap,
                           Boolean iconImage,
                           byte[] iconBytes,
                           ServiceContext serviceContext)
                    throws PortalException,
                           SystemException
Updates the layout with additional parameters.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
parentLayoutId - the primary key of the layout's new parent layout
localeNamesMap - the layout's locales and localized names
localeTitlesMap - the layout's locales and localized titles
descriptionMap - the locales and localized descriptions to merge (optionally null)
keywordsMap - the locales and localized keywords to merge (optionally null)
robotsMap - the locales and localized robots to merge (optionally null)
type - the layout's new type (optionally LayoutConstants.TYPE_PORTLET)
hidden - whether the layout is hidden
friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed see FriendlyURLNormalizerUtil.normalize( String).
iconImage - whether the icon image will be updated
iconBytes - the byte array of the layout's new icon image
serviceContext - the service context to be applied. Can set the modification date and expando bridge attributes for the layout.
Returns:
the updated layout
Throws:
PortalException - if a group or layout with the primary key could not be found, if the user did not have permission to update the layout, if a unique friendly URL could not be generated, if a valid parent layout ID to use could not be found, or if the layout parameters were invalid
SystemException - if a system exception occurred

updateLayout

public Layout updateLayout(long groupId,
                           boolean privateLayout,
                           long layoutId,
                           long parentLayoutId,
                           Map<Locale,String> localeNamesMap,
                           Map<Locale,String> localeTitlesMap,
                           Map<Locale,String> descriptionMap,
                           Map<Locale,String> keywordsMap,
                           Map<Locale,String> robotsMap,
                           String type,
                           boolean hidden,
                           String friendlyURL,
                           Boolean iconImage,
                           byte[] iconBytes,
                           ServiceContext serviceContext)
                    throws PortalException,
                           SystemException
Deprecated. As of 6.2.0, replaced by updateLayout(long, boolean, long, long, Map, Map, Map, Map, Map, String, boolean, Map, Boolean, byte[], ServiceContext)

Updates the layout with additional parameters.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
parentLayoutId - the primary key of the layout's new parent layout
localeNamesMap - the layout's locales and localized names
localeTitlesMap - the layout's locales and localized titles
descriptionMap - the locales and localized descriptions to merge (optionally null)
keywordsMap - the locales and localized keywords to merge (optionally null)
robotsMap - the locales and localized robots to merge (optionally null)
type - the layout's new type (optionally LayoutConstants.TYPE_PORTLET)
hidden - whether the layout is hidden
friendlyURL - the layout's locales and new friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize( String).
iconImage - whether the icon image will be updated
iconBytes - the byte array of the layout's new icon image
serviceContext - the service context to be applied. Can set the modification date and expando bridge attributes for the layout.
Returns:
the updated layout
Throws:
PortalException - if a group or layout with the primary key could not be found, if the user did not have permission to update the layout, if a unique friendly URL could not be generated, if a valid parent layout ID to use could not be found, or if the layout parameters were invalid
SystemException - if a system exception occurred

updateLayout

public Layout updateLayout(long groupId,
                           boolean privateLayout,
                           long layoutId,
                           String typeSettings)
                    throws PortalException,
                           SystemException
Updates the layout replacing its type settings.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
typeSettings - the settings to load the unicode properties object. See #fastLoad(String).
Returns:
the updated layout
Throws:
PortalException - if a matching layout could not be found or if the user did not have permission to update the layout
SystemException - if a system exception occurred

updateLookAndFeel

public Layout updateLookAndFeel(long groupId,
                                boolean privateLayout,
                                long layoutId,
                                String themeId,
                                String colorSchemeId,
                                String css,
                                boolean wapTheme)
                         throws PortalException,
                                SystemException
Updates the look and feel of the layout.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
themeId - the primary key of the layout's new theme
colorSchemeId - the primary key of the layout's new color scheme
css - the layout's new CSS
wapTheme - whether the theme is for WAP browsers
Returns:
the updated layout
Throws:
PortalException - if a matching layout could not be found, or if the user did not have permission to update the layout and permission to apply the theme
SystemException - if a system exception occurred

updateName

public Layout updateName(long groupId,
                         boolean privateLayout,
                         long layoutId,
                         String name,
                         String languageId)
                  throws PortalException,
                         SystemException
Updates the name of the layout matching the group, layout ID, and privacy.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
name - the layout's new name
languageId - the primary key of the language. For more information see Locale.
Returns:
the updated layout
Throws:
PortalException - if a matching layout could not be found, if the user did not have permission to update the layout, or if the new name was null
SystemException - if a system exception occurred

updateName

public Layout updateName(long plid,
                         String name,
                         String languageId)
                  throws PortalException,
                         SystemException
Updates the name of the layout matching the primary key.

Parameters:
plid - the primary key of the layout
name - the name to be assigned
languageId - the primary key of the language. For more information see Locale.
Returns:
the updated layout
Throws:
PortalException - if a layout with the primary key could not be found, or if the user did not have permission to update the layout, or if the name was null
SystemException - if a system exception occurred

updateParentLayoutId

public Layout updateParentLayoutId(long groupId,
                                   boolean privateLayout,
                                   long layoutId,
                                   long parentLayoutId)
                            throws PortalException,
                                   SystemException
Updates the parent layout ID of the layout matching the group, layout ID, and privacy.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
parentLayoutId - the primary key to be assigned to the parent layout
Returns:
the matching layout
Throws:
PortalException - if a valid parent layout ID to use could not be found, if a matching layout could not be found, or if the user did not have permission to update the layout
SystemException - if a system exception occurred

updateParentLayoutId

public Layout updateParentLayoutId(long plid,
                                   long parentPlid)
                            throws PortalException,
                                   SystemException
Updates the parent layout ID of the layout matching the primary key. If a layout matching the parent primary key is found, the layout ID of that layout is assigned, otherwise LayoutConstants.DEFAULT_PARENT_LAYOUT_ID is assigned.

Parameters:
plid - the primary key of the layout
parentPlid - the primary key of the parent layout
Returns:
the layout matching the primary key
Throws:
PortalException - if a layout with the primary key could not be found, if the user did not have permission to update the layout, or if a valid parent layout ID to use could not be found
SystemException - if a system exception occurred

updateParentLayoutIdAndPriority

public Layout updateParentLayoutIdAndPriority(long plid,
                                              long parentPlid,
                                              int priority)
                                       throws PortalException,
                                              SystemException
Throws:
PortalException
SystemException

updatePriority

public Layout updatePriority(long groupId,
                             boolean privateLayout,
                             long layoutId,
                             int priority)
                      throws PortalException,
                             SystemException
Updates the priority of the layout matching the group, layout ID, and privacy.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
priority - the layout's new priority
Returns:
the updated layout
Throws:
PortalException - if a matching layout could not be found or if the user did not have permission to update the layout
SystemException - if a system exception occurred

updatePriority

public Layout updatePriority(long groupId,
                             boolean privateLayout,
                             long layoutId,
                             long nextLayoutId,
                             long previousLayoutId)
                      throws PortalException,
                             SystemException
Updates the priority of the layout matching the group, layout ID, and privacy, setting the layout's priority based on the priorities of the next and previous layouts.

Parameters:
groupId - the primary key of the group
privateLayout - whether the layout is private to the group
layoutId - the primary key of the layout
nextLayoutId - the primary key of the next layout
previousLayoutId - the primary key of the previous layout
Returns:
the updated layout
Throws:
PortalException - if a matching layout could not be found or if the user did not have permission to update the layout
SystemException - if a system exception occurred

updatePriority

public Layout updatePriority(long plid,
                             int priority)
                      throws PortalException,
                             SystemException
Updates the priority of the layout matching the primary key.

Parameters:
plid - the primary key of the layout
priority - the layout's new priority
Returns:
the updated layout
Throws:
PortalException - if a layout with the primary key could not be found
SystemException - if a system exception occurred

validateImportLayoutsFile

public MissingReferences validateImportLayoutsFile(long groupId,
                                                   boolean privateLayout,
                                                   Map<String,String[]> parameterMap,
                                                   File file)
                                            throws PortalException,
                                                   SystemException
Throws:
PortalException
SystemException

validateImportLayoutsFile

public MissingReferences validateImportLayoutsFile(long groupId,
                                                   boolean privateLayout,
                                                   Map<String,String[]> parameterMap,
                                                   InputStream inputStream)
                                            throws PortalException,
                                                   SystemException
Throws:
PortalException
SystemException

validateImportPortletInfo

public MissingReferences validateImportPortletInfo(long plid,
                                                   long groupId,
                                                   String portletId,
                                                   Map<String,String[]> parameterMap,
                                                   File file)
                                            throws PortalException,
                                                   SystemException
Throws:
PortalException
SystemException

validateImportPortletInfo

public MissingReferences validateImportPortletInfo(long plid,
                                                   long groupId,
                                                   String portletId,
                                                   Map<String,String[]> parameterMap,
                                                   InputStream inputStream)
                                            throws PortalException,
                                                   SystemException
Throws:
PortalException
SystemException

filterLayouts

protected List<Layout> filterLayouts(List<Layout> layouts)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5