oracle.webcenter.portal.api

Interface PortalObjectRepository

public interface PortalObjectRepository

This is the entry point to the Portal API. It allows portal objects to be created, retrieved, and queried.

Method Summary

Modifier and Type	Method and Description
<T extends ManagedPortalObject> T	create(PropertyBean bean, Portal portal) Create a new portal object with the properties supplied in the property bean.
boolean	createAllowed(java.lang.Class<? extends ManagedPortalObject> type, Portal portal) Returns a flag indicating whether the current user has permission to create the supplied type within the supplied portal.
<T extends ManagedPortalObject> T	findById(java.lang.String id) Lookup a portal object by ID.
<T extends ManagedPortalObject> T	findById(java.lang.String id, boolean loadGraph) Lookup a portal object by ID.
<T extends ManagedPortalObject> T	findByName(Portal portal, java.lang.String namespace, java.lang.String name) Lookup a portal object by name.
<T extends ManagedPortalObject> T	findByName(Portal portal, java.lang.String namespace, java.lang.String name, boolean loadGraph) Lookup a portal object by name, supplying the containing portal as an object.
<T extends ManagedPortalObject> T	findByName(java.lang.String portal, java.lang.String namespace, java.lang.String name) Lookup a portal object by name, supplying the containing portal by name.
<T extends ManagedPortalObject> T	findByName(java.lang.String portal, java.lang.String namespace, java.lang.String name, boolean loadGraph) Lookup a portal object by name, supplying the containing portal by name.
<T extends ManagedPortalObject> T	findByShortId(java.lang.String shortId) Lookup a portal object by short ID.
<T extends ManagedPortalObject> T	findByShortId(java.lang.String shortId, boolean loadGraph) Lookup a portal object by short ID.
PortalInstance	getDefaultPortal() Gets the Seeded Default Portal for Spaces.This represents the user's home space as well as the portal where shared resources are stored.
PortalObjectQueryFactory	getQueryFactory() Gets the Query Factory for Portal Objects.
boolean	isDefaultPortal(java.lang.String portalId) Deprecated. Not for public use. This method is expected to be removed in the future. Replaced by Portal.isDefault()
<T extends ManagedPortalObject> java.util.List<T>	queryByNameAndType(java.lang.String name, java.lang.Class<T> type, int limit, int offset) Finds a list of portal objects with a given type and a given name.
<T extends BasePage> java.util.List<T>	queryByPagePathAndType(java.lang.String pagePath, java.lang.Class<T> type) Finds a list of objects by page path and type.
<T extends ManagedPortalObject> java.util.List<T>	queryByType(Portal portal, java.lang.Class<T> type, int limit, int offset) Finds a list of portal objects with a given type, within a given portal.
<T extends PropertyBean> java.util.List<T>	toBeanList(java.util.List<? extends ManagedPortalObject<? extends T>> objects) Maps a List of ManagedPortalObject into a List of PropertyBean.

Method Detail

create

<T extends ManagedPortalObject> T create(PropertyBean bean,
                                         Portal portal)

Create a new portal object with the properties supplied in the property bean. The portal object can be associated with a portal by passing a Portal instance. The type of the portal object created is determined by the type of the PropertyBean; for example, passing in a PagePropertyBean will result in creation of a Page portal object. The returned object will be cast to the type requested (which may be a supertype of the real portal object type). The passed in PropertyBean will be updated with the finalised values of all properties. As a result is the bean becomes the equivalent to the bean obtained by calling PortalObject.getProperties() on the newly created ManagedPortalObject.

Parameters:

bean - the property bean specifying the initial state of the new portal object

portal - the portal that this new object belongs to, or null

Returns:

a new portal object, cast to the type requested.

findById

<T extends ManagedPortalObject> T findById(java.lang.String id)

Lookup a portal object by ID.

Parameters:

id - the ID of the portal object to find

Returns:

the portal object cast to the type requested, or null if the object doesn't exist

findByShortId

<T extends ManagedPortalObject> T findByShortId(java.lang.String shortId)

Lookup a portal object by short ID.

Parameters:

shortId - the shortID of the portal object to find

Returns:

the portal object cast to the type requested, or null if the object doesn't exist

findByName

<T extends ManagedPortalObject> T findByName(Portal portal,
                                             java.lang.String namespace,
                                             java.lang.String name)

Lookup a portal object by name.

Parameters:

portal - the portal to search

namespace - the namespace of the object to find

name - the name of the object to find

Returns:

the object with the given qualified name or null if the object does not exist or its type is not as expected

findByName

<T extends ManagedPortalObject> T findByName(java.lang.String portal,
                                             java.lang.String namespace,
                                             java.lang.String name)

Lookup a portal object by name, supplying the containing portal by name.

Parameters:

portal - the name of portal to search

namespace - the namespace of the object to find

name - the name of the object to find

Returns:

the object with the given qualified name or null if the object does not exist or its type is not as expected

findById

<T extends ManagedPortalObject> T findById(java.lang.String id,
                                           boolean loadGraph)

Lookup a portal object by ID.

Parameters:

id - the ID of the portal object to find

loadGraph - Flag to indicate whether the objects referenced objects should be loaded into memory as part of the same query.

Returns:

the portal object cast to the type requested, or null if the object doesn't exist

findByShortId

<T extends ManagedPortalObject> T findByShortId(java.lang.String shortId,
                                                boolean loadGraph)

Lookup a portal object by short ID.

Parameters:

shortId - the shortID of the portal object to find

loadGraph - flag to indicate whether the objects referenced objects should be loaded into memory as part of the same query.

Returns:

the portal object cast to the type requested, or null if the object doesn't exist

findByName

<T extends ManagedPortalObject> T findByName(Portal portal,
                                             java.lang.String namespace,
                                             java.lang.String name,
                                             boolean loadGraph)

Lookup a portal object by name, supplying the containing portal as an object.

Parameters:

portal - the portal to search

namespace - the namespace of the object to find

name - the name of the object to find

loadGraph - flag to indicate whether the objects referenced objects should be loaded into memory as part of the same query.

Returns:

the object with the given qualified name or null if the object does not exist or its type is not as expected

findByName

<T extends ManagedPortalObject> T findByName(java.lang.String portal,
                                             java.lang.String namespace,
                                             java.lang.String name,
                                             boolean loadGraph)

Lookup a portal object by name, supplying the containing portal by name.

Parameters:

portal - the name of portal to search

namespace - the namespace of the object to find

name - the name of the object to find

loadGraph - flag to indicate whether the objects referenced objects should be loaded into memory as part of the same query.

Returns:

the object with the given qualified name or null if the object does not exist or its type is not as expected

queryByType

<T extends ManagedPortalObject> java.util.List<T> queryByType(Portal portal,
                                                              java.lang.Class<T> type,
                                                              int limit,
                                                              int offset)

Finds a list of portal objects with a given type, within a given portal. This method will only return objects that match the type exactly; it will not returns entities that are a subtype of the type.

Parameters:

portal - the portal to search

type - the type of the objects to find

limit - the maximum number of results to return

offset - the index of the first result to return

Returns:

a list of portal objects with the given name in the given portal

queryByPagePathAndType

<T extends BasePage> java.util.List<T> queryByPagePathAndType(java.lang.String pagePath,
                                                              java.lang.Class<T> type)

Finds a list of objects by page path and type. This method will only return objects that match the type exactly; it will not returns entities that are a subtype of the type.

Parameters:

pagePath - the path of the page

type - the type of the objects to find

Returns:

a list of objects with the given page path and type

queryByNameAndType

<T extends ManagedPortalObject> java.util.List<T> queryByNameAndType(java.lang.String name,
                                                                     java.lang.Class<T> type,
                                                                     int limit,
                                                                     int offset)

Finds a list of portal objects with a given type and a given name. This method will only return objects that match the type exactly; it will not returns entities that are a subtype of the type.

Parameters:

name - the name of the object to search

type - the type of the objects to find

limit - the maximum number of results to return

offset - the index of the first result to return

Returns:

a list of portal objects with the given name in the given portal

toBeanList

<T extends PropertyBean> java.util.List<T> toBeanList(java.util.List<? extends ManagedPortalObject<? extends T>> objects)

Maps a List of ManagedPortalObject into a List of PropertyBean.

Parameters:

objects - the list of objects from which the method extracts PropertyBeans

Returns:

a List of PropertyBeans extracted from objects parameter

getDefaultPortal

PortalInstance getDefaultPortal()

Gets the Seeded Default Portal for Spaces.This represents the user's home space as well as the portal where shared resources are stored.

Returns:

the default portal

isDefaultPortal

@Deprecated
boolean isDefaultPortal(java.lang.String portalId)

Deprecated. Not for public use. This method is expected to be removed in the future. Replaced by Portal.isDefault()

Checks if a portal is the default portal by its ID.

Returns:

true if the given ID is the default portal's ID.

getQueryFactory

PortalObjectQueryFactory getQueryFactory()

Gets the Query Factory for Portal Objects.

Returns:

the query Factory

createAllowed

boolean createAllowed(java.lang.Class<? extends ManagedPortalObject> type,
                      Portal portal)

Returns a flag indicating whether the current user has permission to create the supplied type within the supplied portal. If the type is a subtype of Portal then the portal parameter should be left null.

Parameters:

type - The type the user wants to create and instance of

portal - The portal the user wants to create the object within, if any

Returns:

true if the creation is allowed, false if not