public interface PortalPageManager extends SharedEntityAccessor<PortalPage>
SharedEntityAccessor.Factory, SharedEntityAccessor.RetrievalDescriptor
Modifier and Type | Method and Description |
---|---|
PortalPage |
create(PortalPage portalPage)
Creates the specified PortalPage in the database
|
PortalPage |
createBasedOnClone(ApplicationUser pageOwner,
PortalPage portalPage,
PortalPage clonePortalPage)
Creates a PortalPage in the database by cloning its Portlet content from the specified clonePortalPage
|
void |
delete(Long portalPageId)
Deletes the PortalPage with the specified portalPageId
|
EnclosedIterable<PortalPage> |
getAll()
Get all PortalPages.
|
Collection<PortalPage> |
getAllOwnedPortalPages(ApplicationUser owner)
Returns a Collection of PortalPage objects that are owned by the specified User
|
PortalPage |
getPortalPage(ApplicationUser user,
Long portalPageId)
Returns the PortalPage with the specified portalPageId, IF the user is allowed to see it.
|
PortalPage |
getPortalPageById(Long portalPageId)
Gets a PortalPage by id regardless of owner
|
PortalPage |
getPortalPageByName(ApplicationUser owner,
String pageName)
Returns a PortalPage by searching for it by owner and pageName.
|
List<List<PortletConfiguration>> |
getPortletConfigurations(Long portalPageId)
Returns a sorted immutable list of lists of portletconfigurations for a particular portal page.
|
PortalPage |
getSystemDefaultPortalPage()
Returns the system default PortalPage.
|
boolean |
hasShareRights(ApplicationUser user,
PortalPage portalPage,
ShareRight shareRight)
Checks if provided user has share rights for given portal page.
|
void |
saveLegacyPortletConfiguration(PortletConfiguration portletConfiguration)
This can be called to save a
PortletConfiguration object
inside a PortalPage object to the underlying database store. |
SharedEntitySearchResult<PortalPage> |
search(SharedEntitySearchParameters searchParameters,
ApplicationUser user,
int pagePosition,
int pageWidth)
Deprecated.
since v7.1, kept to avoid breaking binary compatibility, also defined in
SharedEntityAccessor.search(com.atlassian.jira.sharing.search.SharedEntitySearchParameters, com.atlassian.jira.user.ApplicationUser, int, int) |
PortalPage |
update(PortalPage portalPage)
Updates the specified PortalPage in the database
|
adjustFavouriteCount, get, get, getAllIndexableSharedEntities, getSharedEntity, getSharedEntity, getType, hasPermissionToUse
PortalPage getPortalPage(ApplicationUser user, Long portalPageId)
user
- the User in playportalPageId
- the id of the PortalPage to returnCollection<PortalPage> getAllOwnedPortalPages(ApplicationUser owner)
owner
- the User who owns the PortalPage'sEnclosedIterable<PortalPage> getAll()
getAll
in interface SharedEntityAccessor<PortalPage>
EnclosedIterable
of PortalPagesPortalPage getPortalPageById(Long portalPageId)
portalPageId
- the id of the PortalPage to retrievePortalPage getPortalPageByName(ApplicationUser owner, String pageName)
owner
- the owner in playpageName
- the name of the PortalPagePortalPage getSystemDefaultPortalPage()
PortalPage create(PortalPage portalPage)
portalPage
- the PortalPage to createPortalPage createBasedOnClone(ApplicationUser pageOwner, PortalPage portalPage, PortalPage clonePortalPage)
pageOwner
- the User who will own the cloned portal pageportalPage
- the PortalPage to createclonePortalPage
- the PortalPage to clone Portlet content fromPortalPage update(PortalPage portalPage)
portalPage
- the PortalPage to updatevoid delete(Long portalPageId)
portalPageId
- the id of the PortalPage to deletevoid saveLegacyPortletConfiguration(PortletConfiguration portletConfiguration)
PortletConfiguration
object
inside a PortalPage
object to the underlying database store.portletConfiguration
- The portletConfiguration to save.SharedEntitySearchResult<PortalPage> search(SharedEntitySearchParameters searchParameters, ApplicationUser user, int pagePosition, int pageWidth)
SharedEntityAccessor.search(com.atlassian.jira.sharing.search.SharedEntitySearchParameters, com.atlassian.jira.user.ApplicationUser, int, int)
search
in interface SharedEntityAccessor<PortalPage>
searchParameters
- the SearchParameters to query.user
- the user performing the search.pagePosition
- the page to return.pageWidth
- the number of results per page.List<List<PortletConfiguration>> getPortletConfigurations(Long portalPageId)
portalPageId
- The portal page id to fetch portlet configs for@ExperimentalApi boolean hasShareRights(@Nullable ApplicationUser user, @Nonnull PortalPage portalPage, @Nonnull ShareRight shareRight)
user
- user which wants for example view or edit the portal pageportalPage
- portal page which permissions and ownership are going to be checkedshareRight
- share right which will be checked if user has itCopyright © 2002-2024 Atlassian. All Rights Reserved.