com.liferay.portlet.sites.util
Interface Sites

public interface Sites

Author:

Eudaldo Alonso

Field Summary

static java.lang.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 java.lang.String	LAST_MERGE_TIME
static java.lang.String	LAST_RESET_TIME
static java.lang.String	LAYOUT_UPDATEABLE
static java.lang.String	MERGE_FAIL_COUNT
static java.lang.String	MERGE_FAIL_FRIENDLY_URL_LAYOUTS

Method Summary

void	addMergeFailFriendlyURLLayout(Layout layout)
void	addPortletBreadcrumbEntries(Group group, javax.servlet.http.HttpServletRequest request, javax.portlet.RenderResponse renderResponse)
void	addPortletBreadcrumbEntries(Group group, java.lang.String pagesName, javax.portlet.PortletURL redirectURL, javax.servlet.http.HttpServletRequest request, javax.portlet.RenderResponse renderResponse)
void	applyLayoutPrototype(LayoutPrototype layoutPrototype, Layout targetLayout, boolean linkEnabled)
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)
java.lang.Object[]	deleteLayout(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
java.lang.Object[]	deleteLayout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	deleteLayout(javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse)
java.io.File	exportLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype, ServiceContext serviceContext)
java.lang.Long[]	filterGroups(java.util.List<Group> groups, java.lang.String[] names)
Layout	getLayoutSetPrototypeLayout(Layout layout)
java.util.Map<java.lang.String,java.lang.String[]>	getLayoutSetPrototypeParameters(ServiceContext serviceContext)
int	getMergeFailCount(LayoutPrototype layoutPrototype)
int	getMergeFailCount(LayoutSetPrototype layoutSetPrototype)
java.util.List<Layout>	getMergeFailFriendlyURLLayouts(LayoutSet layoutSet)
void	importLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype, java.io.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	isOrganizationUser(long companyId, Group group, User user, java.util.List<java.lang.String> organizationNames)
boolean	isUserGroupLayoutSetViewable(PermissionChecker permissionChecker, Group userGroupGroup)
boolean	isUserGroupUser(long companyId, Group group, User user, java.util.List<java.lang.String> userGroupNames)
void	mergeLayoutPrototypeLayout(Group group, Layout layout)
void	mergeLayoutProtypeLayout(Group group, Layout layout) Deprecated. As of 6.2.0, replaced by mergeLayoutPrototypeLayout(Group, Layout)
void	mergeLayoutSetPrototypeLayouts(Group group, LayoutSet layoutSet)
void	mergeLayoutSetProtypeLayouts(Group group, LayoutSet layoutSet) Deprecated. As of 6.2.0, replaced by mergeLayoutSetPrototypeLayouts(Group, 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, javax.portlet.PortletPreferences sourcePreferences, javax.portlet.PortletPreferences targetPreferences, java.lang.String sourcePortletId, java.lang.String languageId)
void	updateLayoutSetPrototypesLinks(Group group, long publicLayoutSetPrototypeId, long privateLayoutSetPrototypeId, boolean publicLayoutSetPrototypeLinkEnabled, boolean privateLayoutSetPrototypeLinkEnabled)

Field Detail

ANALYTICS_PREFIX

static final java.lang.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 java.lang.String LAST_MERGE_TIME

See Also:

Constant Field Values

LAST_RESET_TIME

static final java.lang.String LAST_RESET_TIME

See Also:

Constant Field Values

LAYOUT_UPDATEABLE

static final java.lang.String LAYOUT_UPDATEABLE

See Also:

Constant Field Values

MERGE_FAIL_COUNT

static final java.lang.String MERGE_FAIL_COUNT

See Also:

Constant Field Values

MERGE_FAIL_FRIENDLY_URL_LAYOUTS

static final java.lang.String MERGE_FAIL_FRIENDLY_URL_LAYOUTS

See Also:

Constant Field Values

Method Detail

addMergeFailFriendlyURLLayout

void addMergeFailFriendlyURLLayout(Layout layout)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(Group group,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.portlet.RenderResponse renderResponse)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

addPortletBreadcrumbEntries

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

Throws:

java.lang.Exception

applyLayoutPrototype

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

Throws:

java.lang.Exception

copyLayout

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

Throws:

java.lang.Exception

copyLookAndFeel

void copyLookAndFeel(Layout targetLayout,
                     Layout sourceLayout)
                     throws java.lang.Exception

Throws:

java.lang.Exception

copyPortletPermissions

void copyPortletPermissions(Layout targetLayout,
                            Layout sourceLayout)
                            throws java.lang.Exception

Throws:

java.lang.Exception

copyPortletSetups

void copyPortletSetups(Layout sourceLayout,
                       Layout targetLayout)
                       throws java.lang.Exception

Throws:

java.lang.Exception

copyTypeSettings

void copyTypeSettings(Group sourceGroup,
                      Group targetGroup)
                      throws java.lang.Exception

Throws:

java.lang.Exception

deleteLayout

java.lang.Object[] deleteLayout(javax.portlet.ActionRequest actionRequest,
                                javax.portlet.ActionResponse actionResponse)
                                throws java.lang.Exception

Throws:

java.lang.Exception

deleteLayout

java.lang.Object[] deleteLayout(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                                throws java.lang.Exception

Throws:

java.lang.Exception

deleteLayout

void deleteLayout(javax.portlet.RenderRequest renderRequest,
                  javax.portlet.RenderResponse renderResponse)
                  throws java.lang.Exception

Throws:

java.lang.Exception

exportLayoutSetPrototype

java.io.File exportLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype,
                                      ServiceContext serviceContext)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

filterGroups

java.lang.Long[] filterGroups(java.util.List<Group> groups,
                              java.lang.String[] names)

getLayoutSetPrototypeLayout

Layout getLayoutSetPrototypeLayout(Layout layout)

getLayoutSetPrototypeParameters

java.util.Map<java.lang.String,java.lang.String[]> getLayoutSetPrototypeParameters(ServiceContext serviceContext)

getMergeFailCount

int getMergeFailCount(LayoutPrototype layoutPrototype)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

getMergeFailCount

int getMergeFailCount(LayoutSetPrototype layoutSetPrototype)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

getMergeFailFriendlyURLLayouts

java.util.List<Layout> getMergeFailFriendlyURLLayouts(LayoutSet layoutSet)
                                                      throws PortalException,
                                                             SystemException

Throws:

PortalException

SystemException

importLayoutSetPrototype

void importLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype,
                              java.io.InputStream inputStream,
                              ServiceContext serviceContext)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

isContentSharingWithChildrenEnabled

boolean isContentSharingWithChildrenEnabled(Group group)
                                            throws SystemException

Throws:

SystemException

isFirstLayout

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

Throws:

SystemException

isLayoutDeleteable

boolean isLayoutDeleteable(Layout layout)

isLayoutModifiedSinceLastMerge

boolean isLayoutModifiedSinceLastMerge(Layout layout)
                                       throws PortalException,
                                              SystemException

Throws:

PortalException

SystemException

isLayoutSetMergeable

boolean isLayoutSetMergeable(Group group,
                             LayoutSet layoutSet)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

isLayoutSetPrototypeUpdateable

boolean isLayoutSetPrototypeUpdateable(LayoutSet layoutSet)

isLayoutSortable

boolean isLayoutSortable(Layout layout)

isLayoutUpdateable

boolean isLayoutUpdateable(Layout layout)

isOrganizationUser

boolean isOrganizationUser(long companyId,
                           Group group,
                           User user,
                           java.util.List<java.lang.String> organizationNames)
                           throws java.lang.Exception

Throws:

java.lang.Exception

isUserGroupLayoutSetViewable

boolean isUserGroupLayoutSetViewable(PermissionChecker permissionChecker,
                                     Group userGroupGroup)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

isUserGroupUser

boolean isUserGroupUser(long companyId,
                        Group group,
                        User user,
                        java.util.List<java.lang.String> userGroupNames)
                        throws java.lang.Exception

Throws:

java.lang.Exception

mergeLayoutPrototypeLayout

void mergeLayoutPrototypeLayout(Group group,
                                Layout layout)
                                throws java.lang.Exception

Throws:

java.lang.Exception

mergeLayoutProtypeLayout

void mergeLayoutProtypeLayout(Group group,
                              Layout layout)
                              throws java.lang.Exception

Deprecated. As of 6.2.0, replaced by mergeLayoutPrototypeLayout(Group, Layout)

Throws:

java.lang.Exception

mergeLayoutSetPrototypeLayouts

void mergeLayoutSetPrototypeLayouts(Group group,
                                    LayoutSet layoutSet)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

mergeLayoutSetProtypeLayouts

void mergeLayoutSetProtypeLayouts(Group group,
                                  LayoutSet layoutSet)
                                  throws java.lang.Exception

Deprecated. As of 6.2.0, replaced by mergeLayoutSetPrototypeLayouts(Group, LayoutSet)

Throws:

java.lang.Exception

removeMergeFailFriendlyURLLayouts

void removeMergeFailFriendlyURLLayouts(LayoutSet layoutSet)
                                       throws SystemException

Throws:

SystemException

resetPrototype

void resetPrototype(Layout layout)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

resetPrototype

void resetPrototype(LayoutSet layoutSet)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

setMergeFailCount

void setMergeFailCount(LayoutPrototype layoutPrototype,
                       int newMergeFailCount)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

setMergeFailCount

void setMergeFailCount(LayoutSetPrototype layoutSetPrototype,
                       int newMergeFailCount)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

updateLayoutScopes

void updateLayoutScopes(long userId,
                        Layout sourceLayout,
                        Layout targetLayout,
                        javax.portlet.PortletPreferences sourcePreferences,
                        javax.portlet.PortletPreferences targetPreferences,
                        java.lang.String sourcePortletId,
                        java.lang.String languageId)
                        throws java.lang.Exception

Throws:

java.lang.Exception

updateLayoutSetPrototypesLinks

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

Throws:

java.lang.Exception