Liferay 6.2-ce-ga5

com.liferay.portlet.sites.util
Interface Sites


public interface Sites


Field Summary
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_RESET_TIME
           
static String LAYOUT_UPDATEABLE
           
static String MERGE_FAIL_COUNT
           
static String MERGE_FAIL_FRIENDLY_URL_LAYOUTS
           
 
Method Summary
 void addMergeFailFriendlyURLLayout(Layout layout)
           
 void addPortletBreadcrumbEntries(Group group, javax.servlet.http.HttpServletRequest request, RenderResponse renderResponse)
           
 void addPortletBreadcrumbEntries(Group group, String pagesName, PortletURL redirectURL, javax.servlet.http.HttpServletRequest request, 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)
           
 Object[] deleteLayout(ActionRequest actionRequest, ActionResponse actionResponse)
           
 Object[] deleteLayout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 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)
           
 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 isOrganizationUser(long companyId, Group group, User user, List<String> organizationNames)
           
 boolean isUserGroupLayoutSetViewable(PermissionChecker permissionChecker, Group userGroupGroup)
           
 boolean isUserGroupUser(long companyId, Group group, User user, List<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, 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_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
Method Detail

addMergeFailFriendlyURLLayout

void addMergeFailFriendlyURLLayout(Layout layout)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

addPortletBreadcrumbEntries

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

addPortletBreadcrumbEntries

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

applyLayoutPrototype

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

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(ActionRequest actionRequest,
                      ActionResponse actionResponse)
                      throws Exception
Throws:
Exception

deleteLayout

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

deleteLayout

void deleteLayout(RenderRequest renderRequest,
                  RenderResponse renderResponse)
                  throws Exception
Throws:
Exception

exportLayoutSetPrototype

File exportLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype,
                              ServiceContext serviceContext)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

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,
                             SystemException
Throws:
PortalException
SystemException

getMergeFailCount

int getMergeFailCount(LayoutSetPrototype layoutSetPrototype)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

getMergeFailFriendlyURLLayouts

List<Layout> getMergeFailFriendlyURLLayouts(LayoutSet layoutSet)
                                            throws PortalException,
                                                   SystemException
Throws:
PortalException
SystemException

importLayoutSetPrototype

void importLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype,
                              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,
                           List<String> organizationNames)
                           throws Exception
Throws:
Exception

isUserGroupLayoutSetViewable

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

isUserGroupUser

boolean isUserGroupUser(long companyId,
                        Group group,
                        User user,
                        List<String> userGroupNames)
                        throws Exception
Throws:
Exception

mergeLayoutPrototypeLayout

void mergeLayoutPrototypeLayout(Group group,
                                Layout layout)
                                throws Exception
Throws:
Exception

mergeLayoutProtypeLayout

void mergeLayoutProtypeLayout(Group group,
                              Layout layout)
                              throws Exception
Deprecated. As of 6.2.0, replaced by mergeLayoutPrototypeLayout(Group, Layout)

Throws:
Exception

mergeLayoutSetPrototypeLayouts

void mergeLayoutSetPrototypeLayouts(Group group,
                                    LayoutSet layoutSet)
                                    throws Exception
Throws:
Exception

mergeLayoutSetProtypeLayouts

void mergeLayoutSetProtypeLayouts(Group group,
                                  LayoutSet layoutSet)
                                  throws Exception
Deprecated. As of 6.2.0, replaced by mergeLayoutSetPrototypeLayouts(Group, LayoutSet)

Throws:
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,
                        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

Liferay 6.2-ce-ga5