com.liferay.sites.kernel.util

Interface Sites

public interface Sites

Author:

Eudaldo Alonso

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANALYTICS_PREFIX
static int	CONTENT_SHARING_WITH_CHILDREN_DEFAULT_VALUE
static int	CONTENT_SHARING_WITH_CHILDREN_DISABLED
static int	CONTENT_SHARING_WITH_CHILDREN_DISABLED_BY_DEFAULT
static int	CONTENT_SHARING_WITH_CHILDREN_ENABLED
static int	CONTENT_SHARING_WITH_CHILDREN_ENABLED_BY_DEFAULT
static String	LAST_MERGE_TIME
static String	LAST_MERGE_VERSION
static String	LAST_RESET_TIME
static String	LAYOUT_UPDATEABLE
static String	MERGE_FAIL_COUNT
static String	MERGE_FAIL_FRIENDLY_URL_LAYOUTS
static String	SHOW_SITE_NAME

Method Summary

Modifier and Type	Method and Description
void	addMergeFailFriendlyURLLayout(Layout layout)
void	addPortletBreadcrumbEntries(Group group, javax.servlet.http.HttpServletRequest httpServletRequest, PortletURL portletURL)
void	addPortletBreadcrumbEntries(Group group, javax.servlet.http.HttpServletRequest httpServletRequest, RenderResponse renderResponse)
void	addPortletBreadcrumbEntries(Group group, String pagesName, PortletURL redirectURL, javax.servlet.http.HttpServletRequest httpServletRequest, RenderResponse renderResponse)
void	applyLayoutPrototype(LayoutPrototype layoutPrototype, Layout targetLayout, boolean linkEnabled)
default void	copyExpandoBridgeAttributes(Layout sourceLayout, Layout targetLayout)
void	copyLayout(long userId, Layout sourceLayout, Layout targetLayout, ServiceContext serviceContext)
void	copyLookAndFeel(Layout targetLayout, Layout sourceLayout)
void	copyPortletPermissions(Layout targetLayout, Layout sourceLayout)
void	copyPortletSetups(Layout sourceLayout, Layout targetLayout)
void	copyTypeSettings(Group sourceGroup, Group targetGroup)
Object[]	deleteLayout(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)
Object[]	deleteLayout(PortletRequest portletRequest, PortletResponse portletResponse)
void	deleteLayout(RenderRequest renderRequest, RenderResponse renderResponse)
File	exportLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype, ServiceContext serviceContext)
Long[]	filterGroups(List<Group> groups, String[] names)
Layout	getLayoutSetPrototypeLayout(Layout layout)
Map<String,String[]>	getLayoutSetPrototypeParameters(ServiceContext serviceContext)
int	getMergeFailCount(LayoutPrototype layoutPrototype)
int	getMergeFailCount(LayoutSetPrototype layoutSetPrototype)
List<Layout>	getMergeFailFriendlyURLLayouts(LayoutSet layoutSet)
List<String>	getOrganizationNames(Group group, User user)
List<String>	getUserGroupNames(Group group, User user)
void	importLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype, InputStream inputStream, ServiceContext serviceContext)
boolean	isContentSharingWithChildrenEnabled(Group group)
boolean	isFirstLayout(long groupId, boolean privateLayout, long layoutId)
boolean	isLayoutDeleteable(Layout layout)
boolean	isLayoutModifiedSinceLastMerge(Layout layout)
boolean	isLayoutSetMergeable(Group group, LayoutSet layoutSet)
boolean	isLayoutSetPrototypeUpdateable(LayoutSet layoutSet)
boolean	isLayoutSortable(Layout layout)
boolean	isLayoutUpdateable(Layout layout)
boolean	isUserGroupLayout(Layout layout)
boolean	isUserGroupLayoutSetViewable(PermissionChecker permissionChecker, Group userGroupGroup)
void	mergeLayoutPrototypeLayout(Group group, Layout layout)
void	mergeLayoutSetPrototypeLayouts(Group group, LayoutSet layoutSet)
void	removeMergeFailFriendlyURLLayouts(LayoutSet layoutSet)
void	resetPrototype(Layout layout)
void	resetPrototype(LayoutSet layoutSet)
void	setMergeFailCount(LayoutPrototype layoutPrototype, int newMergeFailCount)
void	setMergeFailCount(LayoutSetPrototype layoutSetPrototype, int newMergeFailCount)
void	updateLayoutScopes(long userId, Layout sourceLayout, Layout targetLayout, PortletPreferences sourcePreferences, PortletPreferences targetPreferences, String sourcePortletId, String languageId)
void	updateLayoutSetPrototypesLinks(Group group, long publicLayoutSetPrototypeId, long privateLayoutSetPrototypeId, boolean publicLayoutSetPrototypeLinkEnabled, boolean privateLayoutSetPrototypeLinkEnabled)

Field Detail

ANALYTICS_PREFIX

static final String ANALYTICS_PREFIX

See Also:

Constant Field Values

CONTENT_SHARING_WITH_CHILDREN_DEFAULT_VALUE

static final int CONTENT_SHARING_WITH_CHILDREN_DEFAULT_VALUE

See Also:

Constant Field Values

CONTENT_SHARING_WITH_CHILDREN_DISABLED

static final int CONTENT_SHARING_WITH_CHILDREN_DISABLED

See Also:

Constant Field Values

CONTENT_SHARING_WITH_CHILDREN_DISABLED_BY_DEFAULT

static final int CONTENT_SHARING_WITH_CHILDREN_DISABLED_BY_DEFAULT

See Also:

Constant Field Values

CONTENT_SHARING_WITH_CHILDREN_ENABLED

static final int CONTENT_SHARING_WITH_CHILDREN_ENABLED

See Also:

Constant Field Values

CONTENT_SHARING_WITH_CHILDREN_ENABLED_BY_DEFAULT

static final int CONTENT_SHARING_WITH_CHILDREN_ENABLED_BY_DEFAULT

See Also:

Constant Field Values

LAST_MERGE_TIME

static final String LAST_MERGE_TIME

See Also:

Constant Field Values

LAST_MERGE_VERSION

static final String LAST_MERGE_VERSION

See Also:

Constant Field Values

LAST_RESET_TIME

static final String LAST_RESET_TIME

See Also:

Constant Field Values

LAYOUT_UPDATEABLE

static final String LAYOUT_UPDATEABLE

See Also:

Constant Field Values

MERGE_FAIL_COUNT

static final String MERGE_FAIL_COUNT

See Also:

Constant Field Values

MERGE_FAIL_FRIENDLY_URL_LAYOUTS

static final String MERGE_FAIL_FRIENDLY_URL_LAYOUTS

See Also:

Constant Field Values

SHOW_SITE_NAME

static final String SHOW_SITE_NAME

See Also:

Constant Field Values

Method Detail

addMergeFailFriendlyURLLayout

void addMergeFailFriendlyURLLayout(Layout layout)
                            throws PortalException

Throws:

PortalException

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(Group group,
                                 javax.servlet.http.HttpServletRequest httpServletRequest,
                                 PortletURL portletURL)
                          throws Exception

Throws:

Exception

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(Group group,
                                 javax.servlet.http.HttpServletRequest httpServletRequest,
                                 RenderResponse renderResponse)
                          throws Exception

Throws:

Exception

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(Group group,
                                 String pagesName,
                                 PortletURL redirectURL,
                                 javax.servlet.http.HttpServletRequest httpServletRequest,
                                 RenderResponse renderResponse)
                          throws Exception

Throws:

Exception

applyLayoutPrototype

void applyLayoutPrototype(LayoutPrototype layoutPrototype,
                          Layout targetLayout,
                          boolean linkEnabled)
                   throws Exception

Throws:

Exception

copyExpandoBridgeAttributes

default void copyExpandoBridgeAttributes(Layout sourceLayout,
                                         Layout targetLayout)

copyLayout

void copyLayout(long userId,
                Layout sourceLayout,
                Layout targetLayout,
                ServiceContext serviceContext)
         throws Exception

Throws:

Exception

copyLookAndFeel

void copyLookAndFeel(Layout targetLayout,
                     Layout sourceLayout)
              throws Exception

Throws:

Exception

copyPortletPermissions

void copyPortletPermissions(Layout targetLayout,
                            Layout sourceLayout)
                     throws Exception

Throws:

Exception

copyPortletSetups

void copyPortletSetups(Layout sourceLayout,
                       Layout targetLayout)
                throws Exception

Throws:

Exception

copyTypeSettings

void copyTypeSettings(Group sourceGroup,
                      Group targetGroup)
               throws Exception

Throws:

Exception

deleteLayout

Object[] deleteLayout(javax.servlet.http.HttpServletRequest httpServletRequest,
                      javax.servlet.http.HttpServletResponse httpServletResponse)
               throws Exception

Throws:

Exception

deleteLayout

Object[] deleteLayout(PortletRequest portletRequest,
                      PortletResponse portletResponse)
               throws Exception

Throws:

Exception

deleteLayout

void deleteLayout(RenderRequest renderRequest,
                  RenderResponse renderResponse)
           throws Exception

Throws:

Exception

exportLayoutSetPrototype

File exportLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype,
                              ServiceContext serviceContext)
                       throws PortalException

Throws:

PortalException

filterGroups

Long[] filterGroups(List<Group> groups,
                    String[] names)

getLayoutSetPrototypeLayout

Layout getLayoutSetPrototypeLayout(Layout layout)

getLayoutSetPrototypeParameters

Map<String,String[]> getLayoutSetPrototypeParameters(ServiceContext serviceContext)

getMergeFailCount

int getMergeFailCount(LayoutPrototype layoutPrototype)
               throws PortalException

Throws:

PortalException

getMergeFailCount

int getMergeFailCount(LayoutSetPrototype layoutSetPrototype)
               throws PortalException

Throws:

PortalException

getMergeFailFriendlyURLLayouts

List<Layout> getMergeFailFriendlyURLLayouts(LayoutSet layoutSet)
                                     throws PortalException

Throws:

PortalException

getOrganizationNames

List<String> getOrganizationNames(Group group,
                                  User user)
                           throws Exception

Throws:

Exception

getUserGroupNames

List<String> getUserGroupNames(Group group,
                               User user)
                        throws Exception

Throws:

Exception

importLayoutSetPrototype

void importLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype,
                              InputStream inputStream,
                              ServiceContext serviceContext)
                       throws PortalException

Throws:

PortalException

isContentSharingWithChildrenEnabled

boolean isContentSharingWithChildrenEnabled(Group group)

isFirstLayout

boolean isFirstLayout(long groupId,
                      boolean privateLayout,
                      long layoutId)

isLayoutDeleteable

boolean isLayoutDeleteable(Layout layout)

isLayoutModifiedSinceLastMerge

boolean isLayoutModifiedSinceLastMerge(Layout layout)
                                throws PortalException

Throws:

PortalException

isLayoutSetMergeable

boolean isLayoutSetMergeable(Group group,
                             LayoutSet layoutSet)
                      throws PortalException

Throws:

PortalException

isLayoutSetPrototypeUpdateable

boolean isLayoutSetPrototypeUpdateable(LayoutSet layoutSet)

isLayoutSortable

boolean isLayoutSortable(Layout layout)

isLayoutUpdateable

boolean isLayoutUpdateable(Layout layout)

isUserGroupLayout

boolean isUserGroupLayout(Layout layout)
                   throws PortalException

Throws:

PortalException

isUserGroupLayoutSetViewable

boolean isUserGroupLayoutSetViewable(PermissionChecker permissionChecker,
                                     Group userGroupGroup)
                              throws PortalException

Throws:

PortalException

mergeLayoutPrototypeLayout

void mergeLayoutPrototypeLayout(Group group,
                                Layout layout)
                         throws Exception

Throws:

Exception

mergeLayoutSetPrototypeLayouts

void mergeLayoutSetPrototypeLayouts(Group group,
                                    LayoutSet layoutSet)
                             throws Exception

Throws:

Exception

removeMergeFailFriendlyURLLayouts

void removeMergeFailFriendlyURLLayouts(LayoutSet layoutSet)
                                throws PortalException

Throws:

PortalException

resetPrototype

void resetPrototype(Layout layout)
             throws PortalException

Throws:

PortalException

resetPrototype

void resetPrototype(LayoutSet layoutSet)
             throws PortalException

Throws:

PortalException

setMergeFailCount

void setMergeFailCount(LayoutPrototype layoutPrototype,
                       int newMergeFailCount)
                throws PortalException

Throws:

PortalException

setMergeFailCount

void setMergeFailCount(LayoutSetPrototype layoutSetPrototype,
                       int newMergeFailCount)
                throws PortalException

Throws:

PortalException

updateLayoutScopes

void updateLayoutScopes(long userId,
                        Layout sourceLayout,
                        Layout targetLayout,
                        PortletPreferences sourcePreferences,
                        PortletPreferences targetPreferences,
                        String sourcePortletId,
                        String languageId)
                 throws Exception

Throws:

Exception

updateLayoutSetPrototypesLinks

void updateLayoutSetPrototypesLinks(Group group,
                                    long publicLayoutSetPrototypeId,
                                    long privateLayoutSetPrototypeId,
                                    boolean publicLayoutSetPrototypeLinkEnabled,
                                    boolean privateLayoutSetPrototypeLinkEnabled)
                             throws Exception

Throws:

Exception