oracle.webcenter.portal.persistence

Interface PersistenceManager

public interface PersistenceManager

Manages instances of model interfaces for clients of the Portal Persistence API.

Method Summary

Modifier and Type	Method and Description
void	cleanUpPortalResource(PortalResource resource) Deletes all the entities related to a portal in the core portal tables
<T extends PortalEntity> T	copy(T source, PortalResource targetPortal, java.lang.String targetNamespace, java.lang.String targetName) Make a copy of the supplied PortalEntity, giving the new object the supplied owning portal, namespace and name.
<T extends PortalEntity> T	create(java.lang.Class<T> c) Creates and persists a PortalEntity object of a given type.
<T extends PortalEntity> T	create(java.lang.Class<T> c, java.lang.String id) Create and persists a PortalEntity object of a given type with Id provided.
<T extends PortalEntity> T	create(java.lang.Class<T> c, java.lang.String id, java.lang.String versionId) Create and persists a PortalEntity object of a given type with Id and version Id provided.
boolean	createAllowed(java.lang.Class<? extends PortalEntity> type, PortalResource portal) Returns a flag indicating whether the current user has permission to create the supplied type within the supplied portal.
Query<PortalEntity>	createQuery() Creates a query object which can be used to build up a query of portal objects of any type.
<T extends PortalEntity> Query<T>	createQuery(java.lang.Class<T> type) Creates a query object which can be used to build up a query of portal objects of a given type.
<S extends PortalEntity,T extends PortalEntity> T	deepCopy(S source, PortalResource targetPortal, java.lang.String targetNamespace, java.lang.String targetName, java.lang.Class<T> targetType) Make a deep copy of the supplied PortalEntity, giving the new object the supplied owning portal, namespace, name, and type.
<S extends PortalEntity,T extends PortalEntity> T	deepCopy(S source, PortalResource targetPortal, java.lang.String targetNamespace, java.lang.String targetName, java.lang.Class<T> targetType, PostCopy<T> postCopy, java.lang.String[] excludedReferenceNames) Make a deep copy of the supplied PortalEntity, giving the new object the supplied owning portal, namespace, name, and type.
<S extends PortalEntity,T extends PortalEntity> T	deepCopy(S source, T target) Make a deep copy of the supplied source PortalEntity to the supplied target PortalEntity.
<S extends PortalEntity,T extends PortalEntity> T	deepCopy(S source, T target, PostCopy<T> postCopy) Make a deep copy of the supplied source PortalEntity to the supplied target PortalEntity.
<T extends PortalEntity> T	deepCopy(T source, PortalResource targetPortal, java.lang.String targetNamespace, java.lang.String targetName) Make a deep copy of the supplied PortalEntity, giving the new object the supplied owning portal, namespace and name.
<T extends PortalEntity> T	deepCopy(T source, PortalResource targetPortal, java.lang.String targetNamespace, java.lang.String targetName, PostCopy<T> postCopy) Make a deep copy of the supplied PortalEntity, giving the new object the supplied owning portal, namespace and name.
boolean	delete(PortalEntity portalEntity) Deletes the persisted PortalEntity object passed into the method.
boolean	deleteById(java.lang.String id) Delete a persisted PortalEntity by ID.
boolean	deleteByName(PortalEntity portal, java.lang.String namespace, java.lang.String name) Delete a persisted PortalEntity by portal, namespace and name.
boolean	deleteByShortId(java.lang.String shortId) Delete a persisted PortalEntity by short ID.
org.w3c.dom.Document	exportXML(java.util.Set<? extends PortalEntity> entities, boolean followRefs) Deprecated. Replaced by exportXML(Set, ExportOptions)
org.w3c.dom.Document	exportXML(java.util.Set<? extends PortalEntity> entities, ExportOptions options) Exports a set of PortalEntity objects to an XML document.
PortalEntity	findById(java.lang.String id) Finds a persisted object by ID.
PortalEntity	findById(java.lang.String id, boolean loadGraph) Finds a persisted object by ID.
<T extends PortalEntity> T	findById(java.lang.String id, java.lang.Class<T> returnType) Finds a persisted object of a given type by ID.
<T extends PortalEntity> T	findById(java.lang.String id, java.lang.Class<T> returnType, boolean loadGraph) Finds a persisted object of a given type by ID.
PortalEntity	findByName(PortalEntity portal, java.lang.String namespace, java.lang.String name) Finds a persisted object by name.
PortalEntity	findByName(PortalEntity portal, java.lang.String namespace, java.lang.String name, boolean loadGraph) Finds a persisted object by name.
<T extends PortalEntity> T	findByName(PortalEntity portal, java.lang.String namespace, java.lang.String name, java.lang.Class<T> returnType) Finds a persisted object of a given type by name.
<T extends PortalEntity> T	findByName(PortalEntity portal, java.lang.String namespace, java.lang.String name, java.lang.Class<T> returnType, boolean loadGraph) Finds a persisted object of a given type by name.
PortalEntity	findByName(java.lang.String portal, java.lang.String namespace, java.lang.String name) Finds a persisted object by name.
PortalEntity	findByName(java.lang.String portal, java.lang.String namespace, java.lang.String name, boolean loadGraph) Finds a persisted object by name.
<T extends PortalEntity> T	findByName(java.lang.String portal, java.lang.String namespace, java.lang.String name, java.lang.Class<T> returnType) Finds a persisted object of a given type by name.
<T extends PortalEntity> T	findByName(java.lang.String portal, java.lang.String namespace, java.lang.String name, java.lang.Class<T> returnType, boolean loadGraph) Finds a persisted object of a given type by name.
PortalEntity	findByShortId(java.lang.String shortId) Finds a persisted object by short ID.
PortalEntity	findByShortId(java.lang.String shortId, boolean loadGraph) Finds a persisted object by short ID.
<T extends PortalEntity> T	findByShortId(java.lang.String shortId, java.lang.Class<T> returnType) Finds a persisted object of a given type by short ID.
<T extends PortalEntity> T	findByShortId(java.lang.String shortId, java.lang.Class<T> returnType, boolean loadGraph) Finds a persisted object of a given type by short ID.
java.util.List<java.lang.String>	findSourceIdBySourceAndName(java.lang.String name, java.util.List<java.lang.String> sources, PaginationRule page) Find ids of a list persisted objects that are the source of a particular reference
<T extends PortalEntity> java.util.List<T>	getEntitiesForExport(PortalEntity entity) Returns a list of PortalEntities that will be exported when the supplied entity is exported.
ImportReport	getImportReport(org.w3c.dom.Document... exportData) Generates a report on an export set.
PersistenceListener	getPersistenceListener() Gets the listener from the PersistenceManager.
java.util.Set<PortalEntity>	importXML(org.w3c.dom.Document... exportData) Imports a set of PortalEntity objects.
java.util.Set<PortalEntity>	importXML(PortalEntity portal, org.w3c.dom.Document... exportData) Imports a set of PortalEntity objects.
void	lock(PortalEntity entity, LockMode lockMode) Locks a PortalEntity object
void	notifyExternallyModified() Notifies PersistenceManager of changes to the database.
<T extends PortalEntity> java.util.List<T>	queryByDocumentRefAndType(java.lang.String documentRef, java.util.List<java.lang.Class<? extends PortalEntity>> types, PaginationRule page) Finds a list of portal objects with a type in the list of given types and the provided document ref.
java.util.List<PortalEntity>	queryByName(PortalEntity portal, java.lang.String name, PaginationRule page) Finds a list of portal objects with a given name, within a given portal
<T extends PortalEntity> java.util.List<T>	queryByNameAndType(java.lang.String name, java.lang.Class<T> type, PaginationRule page) Finds a list of portal objects with a given type and name.
<T extends PortalEntity> java.util.List<T>	queryByNameAndType(java.lang.String name, java.util.List<java.lang.Class<? extends PortalEntity>> types, PaginationRule page) Finds a list of portal objects with a type in the list of given types and the provided name.
<T extends PortalEntity> java.util.List<T>	queryByType(java.lang.Class<T> type, PaginationRule page) Finds a list of portal objects with a given type.
<T extends PortalEntity> java.util.List<T>	queryByType(java.util.List<java.lang.Class<? extends PortalEntity>> types, PaginationRule page) Finds a list of portal objects with a type in the list of given types.
<T extends PortalEntity> java.util.List<T>	queryByType(PortalEntity portal, java.lang.Class<T> type, PaginationRule page) Finds a list of portal objects with a given type, within a given portal.
<T extends PortalEntity> java.util.List<T>	queryByType(PortalEntity portal, java.util.List<java.lang.Class<? extends PortalEntity>> types, PaginationRule page) Finds a list of portal objects with a type in the list of given types, within a given portal.
<T extends PortalEntity> java.util.List<T>	queryByTypeAndModifiedDate(java.lang.Class<T> type, java.util.Date fromDate, java.util.Date toDate, PaginationRule page) Finds a list of portal objects with a given type and within a timestamp.
<T extends PortalEntity> java.util.List<T>	queryByTypeAndModifiedDate(java.util.List<java.lang.Class<? extends PortalEntity>> types, java.util.Date fromDate, java.util.Date toDate, PaginationRule page) Finds a list of portal objects with a type in the list of given types and within a timestamp.
<T extends PortalEntity> java.util.List<T>	queryByTypeAndModifiedDate(PortalEntity portal, java.lang.Class<T> type, java.util.Date fromDate, java.util.Date toDate, PaginationRule page) Finds a list of portal objects with a given type and within a timestamp, within a given portal.
<T extends PortalEntity> java.util.List<T>	queryByTypeAndModifiedDate(PortalEntity portal, java.util.List<java.lang.Class<? extends PortalEntity>> types, java.util.Date fromDate, java.util.Date toDate, PaginationRule page) Finds a list of portal objects with a type in the list of given types and within a timestamp, within a given portal.
void	registerPersistenceListener(PersistenceListener listener) Register the listener with the PersistenceManager.

Method Detail

create

<T extends PortalEntity> T create(java.lang.Class<T> c)

Creates and persists a PortalEntity object of a given type.

Parameters:

c - a Class representing the type of object to create and persist

Returns:

the newly created PortalEntity object

Throws:

AbstractEntityException - if the requested type is marked as abstract

create

<T extends PortalEntity> T create(java.lang.Class<T> c,
                                  java.lang.String id)

Create and persists a PortalEntity object of a given type with Id provided.

Parameters:

c - a Class representing the type of object to create and persist

id - the ID of the object

Returns:

the newly created PortalEntity object

Throws:

AbstractEntityException - if the requested type is marked as abstract

create

<T extends PortalEntity> T create(java.lang.Class<T> c,
                                  java.lang.String id,
                                  java.lang.String versionId)

Create and persists a PortalEntity object of a given type with Id and version Id provided.

Parameters:

c - a Class representing the type of object to create and persist

id - the ID of the object

versionId - the version ID of the object

Returns:

the newly created PortalEntity object

Throws:

AbstractEntityException - if the requested type is marked as abstract

findById

PortalEntity findById(java.lang.String id)

Finds a persisted object by ID.

Parameters:

id - the ID of the object to find

Returns:

the object with the given ID or null if the object does not exist

findById

PortalEntity findById(java.lang.String id,
                      boolean loadGraph)

Finds a persisted object by ID.

Parameters:

id - the ID of the object to find

loadGraph - whether to load the object graph (following the eager references)

Returns:

the object with the given ID or null if the object does not exist

findById

<T extends PortalEntity> T findById(java.lang.String id,
                                    java.lang.Class<T> returnType)

Finds a persisted object of a given type by ID.

Parameters:

id - the ID of the object to find

returnType - the expected type of the object to be found

Returns:

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

Throws:

java.lang.IllegalArgumentException - if the object with the given id is not of the requested type (returnType)

AbstractEntityException - if the type of the entity with this ID is marked as abstract

findById

<T extends PortalEntity> T findById(java.lang.String id,
                                    java.lang.Class<T> returnType,
                                    boolean loadGraph)

Finds a persisted object of a given type by ID.

Parameters:

id - the ID of the object to find

returnType - the expected type of the object to be found

loadGraph - whether to load the object graph (following the eager references)

Returns:

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

Throws:

java.lang.IllegalArgumentException - if the object with the given id is not of the requested type (returnType)

AbstractEntityException - if the type of the entity with this ID is marked as abstract

findByShortId

PortalEntity findByShortId(java.lang.String shortId)
                    throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a persisted object by short ID.

Parameters:

shortId - the short ID of the object to find

Returns:

the object with the given short ID or null if the object does not exist

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

findByShortId

PortalEntity findByShortId(java.lang.String shortId,
                           boolean loadGraph)
                    throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a persisted object by short ID.

Parameters:

shortId - the short ID of the object to find

loadGraph - whether to load the object graph (following the eager references)

Returns:

the object with the given short ID or null if the object does not exist

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

findByShortId

<T extends PortalEntity> T findByShortId(java.lang.String shortId,
                                         java.lang.Class<T> returnType)
                                  throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a persisted object of a given type by short ID.

Parameters:

shortId - the short ID of the object to find

returnType - the expected type of the object to be found

Returns:

the object with the given short ID or null if the object does not exist or its type is not as expected

Throws:

java.lang.IllegalArgumentException - if the object with the given id is not of the requested type (returnType)

AbstractEntityException - if the type of the entity with this ID is marked as abstract

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

findByShortId

<T extends PortalEntity> T findByShortId(java.lang.String shortId,
                                         java.lang.Class<T> returnType,
                                         boolean loadGraph)
                                  throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a persisted object of a given type by short ID.

Parameters:

shortId - the short ID of the object to find

returnType - the expected type of the object to be found

loadGraph - whether to load the object graph (following the eager references)

Returns:

the object with the given short ID or null if the object does not exist or its type is not as expected

Throws:

java.lang.IllegalArgumentException - if the object with the giveni short id is not of the requested type (returnType)

AbstractEntityException - if the type of the entity with this short ID is marked as abstract

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

findByName

PortalEntity findByName(PortalEntity portal,
                        java.lang.String namespace,
                        java.lang.String name)
                 throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a persisted 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 properties or null if the object does not exist

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

findByName

<T extends PortalEntity> T findByName(PortalEntity portal,
                                      java.lang.String namespace,
                                      java.lang.String name,
                                      java.lang.Class<T> returnType)
                               throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a persisted object of a given type by name.

Parameters:

portal - the portal to search

namespace - the namespace of the object to find

name - the name of the object to find

returnType - the expected type of the object to be found

Returns:

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

Throws:

java.lang.IllegalArgumentException - if the object with the given id is not of the requested type (returnType)

AbstractEntityException - if the type of the entity with this ID is marked as abstract

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

findByName

PortalEntity findByName(PortalEntity portal,
                        java.lang.String namespace,
                        java.lang.String name,
                        boolean loadGraph)
                 throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a persisted 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

loadGraph - whether to load the object graph (following the eager references)

Returns:

the object with the given properties or null if the object does not exist

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

findByName

<T extends PortalEntity> T findByName(PortalEntity portal,
                                      java.lang.String namespace,
                                      java.lang.String name,
                                      java.lang.Class<T> returnType,
                                      boolean loadGraph)
                               throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a persisted object of a given type by name.

Parameters:

portal - the portal to search

namespace - the namespace of the object to find

name - the name of the object to find

returnType - the expected type of the object to be found

loadGraph - whether to load the object graph (following the eager references)

Returns:

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

Throws:

java.lang.IllegalArgumentException - if the object with the given id is not of the requested type (returnType)

AbstractEntityException - if the type of the entity with this ID is marked as abstract

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

findByName

PortalEntity findByName(java.lang.String portal,
                        java.lang.String namespace,
                        java.lang.String name)
                 throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a persisted object by name.

Parameters:

portal - the portal to search, specified by name

namespace - the namespace of the object to find

name - the name of the object to find

Returns:

the object with the given properties or null if the object does not exist

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

findByName

<T extends PortalEntity> T findByName(java.lang.String portal,
                                      java.lang.String namespace,
                                      java.lang.String name,
                                      java.lang.Class<T> returnType)
                               throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a persisted object of a given type by name.

Parameters:

portal - the portal to search, specified by name

namespace - the namespace of the object to find

name - the name of the object to find

returnType - the expected type of the object to be found

Returns:

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

Throws:

java.lang.IllegalArgumentException - if the object with the given id is not of the requested type (returnType)

AbstractEntityException - if the type of the entity with this ID is marked as abstract

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

findByName

PortalEntity findByName(java.lang.String portal,
                        java.lang.String namespace,
                        java.lang.String name,
                        boolean loadGraph)
                 throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a persisted object by name.

Parameters:

portal - the portal to search, specified by name

namespace - the namespace of the object to find

name - the name of the object to find

loadGraph - whether to load the object graph (following the eager references)

Returns:

the object with the given properties or null if the object does not exist

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

findByName

<T extends PortalEntity> T findByName(java.lang.String portal,
                                      java.lang.String namespace,
                                      java.lang.String name,
                                      java.lang.Class<T> returnType,
                                      boolean loadGraph)
                               throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a persisted object of a given type by name.

Parameters:

portal - the portal to search, specified by name

namespace - the namespace of the object to find

name - the name of the object to find

returnType - the expected type of the object to be found

loadGraph - whether to load the object graph (following the eager references)

Returns:

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

Throws:

java.lang.IllegalArgumentException - if the object with the given id is not of the requested type (returnType)

AbstractEntityException - if the type of the entity with this ID is marked as abstract

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

queryByName

java.util.List<PortalEntity> queryByName(PortalEntity portal,
                                         java.lang.String name,
                                         PaginationRule page)
                                  throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a list of portal objects with a given name, within a given portal

Parameters:

portal - the portal to search

name - the name of the objects to find

page - the page of results to return

Returns:

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

Throws:

AbstractEntityException - if the type of any of the entities are marked as abstract

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

queryByType

<T extends PortalEntity> java.util.List<T> queryByType(PortalEntity portal,
                                                       java.lang.Class<T> type,
                                                       PaginationRule page)
                                                throws oracle.webcenter.portal.PortalOptimisticLockException

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

Parameters:

portal - the portal to search

type - the type of the objects to find

page - the page of results to return

Returns:

a list of portal entities with the given type in the given portal

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

queryByType

<T extends PortalEntity> java.util.List<T> queryByType(PortalEntity portal,
                                                       java.util.List<java.lang.Class<? extends PortalEntity>> types,
                                                       PaginationRule page)
                                                throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a list of portal objects with a type in the list of given types, within a given portal. The method returns all entities in the portal that have a specific type matching one of the types in the supplied list.

Parameters:

portal - the portal to search

types - a list of types of objects to find

page - the page of results to return

Returns:

a list of portal entities with the given type in the given portal

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

queryByTypeAndModifiedDate

<T extends PortalEntity> java.util.List<T> queryByTypeAndModifiedDate(PortalEntity portal,
                                                                      java.lang.Class<T> type,
                                                                      java.util.Date fromDate,
                                                                      java.util.Date toDate,
                                                                      PaginationRule page)
                                                               throws oracle.webcenter.portal.PortalOptimisticLockException

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

Parameters:

portal - the portal to search

type - the type of the objects to find

fromDate - the start time for the modified date

toDate - the end time for the modified date

page - the page of results to return

Returns:

a list of portal entities with the given type and within a timestamp in the given portal

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

queryByTypeAndModifiedDate

<T extends PortalEntity> java.util.List<T> queryByTypeAndModifiedDate(PortalEntity portal,
                                                                      java.util.List<java.lang.Class<? extends PortalEntity>> types,
                                                                      java.util.Date fromDate,
                                                                      java.util.Date toDate,
                                                                      PaginationRule page)
                                                               throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a list of portal objects with a type in the list of given types and within a timestamp, within a given portal. The method returns all entities in the portal that have a specific type matching one of the types in the supplied list.

Parameters:

portal - the portal to search

types - a list of types of objects to find

fromDate - the start time for the modified date

toDate - the end time for the modified date

page - the page of results to return

Returns:

a list of portal entities with the given type and within a timestamp in the given portal

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

queryByType

<T extends PortalEntity> java.util.List<T> queryByType(java.lang.Class<T> type,
                                                       PaginationRule page)
                                                throws oracle.webcenter.portal.PortalOptimisticLockException

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

Parameters:

type - the type of the objects to find

page - the page of results to return

Returns:

a list of portal entities with the given type

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

queryByType

<T extends PortalEntity> java.util.List<T> queryByType(java.util.List<java.lang.Class<? extends PortalEntity>> types,
                                                       PaginationRule page)
                                                throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a list of portal objects with a type in the list of given types. The method returns all entities that have a specific type matching one of the types in the supplied list.

Parameters:

types - a list of types of objects to find

page - the page of results to return

Returns:

a list of portal entities with the given type

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

queryByTypeAndModifiedDate

<T extends PortalEntity> java.util.List<T> queryByTypeAndModifiedDate(java.lang.Class<T> type,
                                                                      java.util.Date fromDate,
                                                                      java.util.Date toDate,
                                                                      PaginationRule page)
                                                               throws oracle.webcenter.portal.PortalOptimisticLockException

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

Parameters:

type - the type of the objects to find

fromDate - the start time for the modified date

toDate - the end time for the modified date

page - the page of results to return

Returns:

a list of portal entities with the given type and within a timestamp

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

queryByTypeAndModifiedDate

<T extends PortalEntity> java.util.List<T> queryByTypeAndModifiedDate(java.util.List<java.lang.Class<? extends PortalEntity>> types,
                                                                      java.util.Date fromDate,
                                                                      java.util.Date toDate,
                                                                      PaginationRule page)
                                                               throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a list of portal objects with a type in the list of given types and within a timestamp. The method returns all entities that have a specific type matching one of the types in the supplied list.

Parameters:

types - a list of types of objects to find

fromDate - the start time for the modified date

toDate - the end time for the modified date

page - the page of results to return

Returns:

a list of portal entities with the given type and within a timestamp

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

queryByNameAndType

<T extends PortalEntity> java.util.List<T> queryByNameAndType(java.lang.String name,
                                                              java.lang.Class<T> type,
                                                              PaginationRule page)
                                                       throws oracle.webcenter.portal.PortalOptimisticLockException

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

Parameters:

name - the object name to search

type - the type of the objects to find

page - the page of results to return

Returns:

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

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

queryByNameAndType

<T extends PortalEntity> java.util.List<T> queryByNameAndType(java.lang.String name,
                                                              java.util.List<java.lang.Class<? extends PortalEntity>> types,
                                                              PaginationRule page)
                                                       throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a list of portal objects with a type in the list of given types and the provided name. The method returns all entities in the portal that have a specific type matching one of the types in the supplied list.

Parameters:

name - the name of the type to search

types - a list of types of objects to find

page - the page of results to return

Returns:

a list of portal entities with the given name

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

queryByDocumentRefAndType

<T extends PortalEntity> java.util.List<T> queryByDocumentRefAndType(java.lang.String documentRef,
                                                                     java.util.List<java.lang.Class<? extends PortalEntity>> types,
                                                                     PaginationRule page)
                                                              throws oracle.webcenter.portal.PortalOptimisticLockException

Finds a list of portal objects with a type in the list of given types and the provided document ref. The method returns all entities in the portal that have a specific type matching one of the types in the supplied list.

Parameters:

documentRef - the documentRef of the type to search

types - a list of types of objects to find

page - the page of results to return

Returns:

a list of portal entities with the given document ref

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction

createQuery

Query<PortalEntity> createQuery()

Creates a query object which can be used to build up a query of portal objects of any type.

Note that object of all types will be queried unless the from-clause is set using the Query.from(java.lang.Class<? extends T>...) method.

Returns:

the query

createQuery

<T extends PortalEntity> Query<T> createQuery(java.lang.Class<T> type)

Creates a query object which can be used to build up a query of portal objects of a given type.

Note that only objets of the specifed type will be queried (it will not query objects that are a subtype of the specifed type) unless the from-clause is set using the Query.from(java.lang.Class<? extends T>...) method.

Parameters:

type - the type being queried

Returns:

the query

deleteById

boolean deleteById(java.lang.String id)
            throws oracle.webcenter.portal.PortalOptimisticLockException

Delete a persisted PortalEntity by ID.

Parameters:

id - the ID of the PortalEntity to delete

Returns:

true if the PortalEntity is deleted, otherwise false if the PortalEntity was not available to delete

Throws:

PersistenceAuthorizationException - if entity with the given ID is secured and the current user does not have permission to delete it

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

deleteByName

boolean deleteByName(PortalEntity portal,
                     java.lang.String namespace,
                     java.lang.String name)
              throws oracle.webcenter.portal.PortalOptimisticLockException

Delete a persisted PortalEntity by portal, namespace and name.

Parameters:

portal - the portal to search

namespace - the namespace of the object to delete

name - the name of the object to delete

Returns:

true if the PortalEntity is deleted, otherwise false if the PortalEntity was not available to delete

Throws:

PersistenceAuthorizationException - if named entity is secured and the current user does not have permission to delete it

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

deleteByShortId

boolean deleteByShortId(java.lang.String shortId)
                 throws oracle.webcenter.portal.PortalOptimisticLockException

Delete a persisted PortalEntity by short ID.

Parameters:

shortId - the short ID of the PortalEntity to delete

Returns:

true if the PortalEntity is deleted, otherwise false if the PortalEntity was not available to delete

Throws:

PersistenceAuthorizationException - if entity with the given short ID is secured and the current user does not have permission to delete it

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

delete

boolean delete(PortalEntity portalEntity)
        throws oracle.webcenter.portal.PortalOptimisticLockException

Deletes the persisted PortalEntity object passed into the method.

Parameters:

portalEntity - the PortalEntity to delete

Returns:

true if the PortalEntity is deleted, otherwise false if the PortalEntity was not available to delete

Throws:

PersistenceAuthorizationException - if entity is secured and the current user does not have permission to delete it

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

copy

<T extends PortalEntity> T copy(T source,
                                PortalResource targetPortal,
                                java.lang.String targetNamespace,
                                java.lang.String targetName)
                         throws DuplicateNameException

Make a copy of the supplied PortalEntity, giving the new object the supplied owning portal, namespace and name.

Parameters:

source - The PortalEntity to copy.

targetPortal - Portal for the new PortalEntity.

targetNamespace - Namespace for the new PortalEntity.

targetName - Name for the new PortalEntity.

Returns:

A copy of the source PortalEntity, with the specified new name.

Throws:

DuplicateNameException

deepCopy

<T extends PortalEntity> T deepCopy(T source,
                                    PortalResource targetPortal,
                                    java.lang.String targetNamespace,
                                    java.lang.String targetName)
                             throws DuplicateNameException,
                                    oracle.webcenter.portal.PortalOptimisticLockException

Make a deep copy of the supplied PortalEntity, giving the new object the supplied owning portal, namespace and name.

All strong references will be followed and copies made of the referenced entities. Weak references will be copied such that the new objects reference the same entities as the original object. Objects that are copied by following strong references will be given a temporary name unless the object is copied to a new portal, in which case the original name is retained.

The newly created entities will inherit security from the same entities as the corresponding source entities.

Parameters:

source - The PortalEntity to copy.

targetPortal - Portal for the new PortalEntity.

targetNamespace - Namespace for the new PortalEntity.

targetName - Name for the new PortalEntity.

Returns:

A deep copy of the source PortalEntity, with the specified new name.

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

DuplicateNameException

deepCopy

<T extends PortalEntity> T deepCopy(T source,
                                    PortalResource targetPortal,
                                    java.lang.String targetNamespace,
                                    java.lang.String targetName,
                                    PostCopy<T> postCopy)
                             throws DuplicateNameException,
                                    oracle.webcenter.portal.PortalOptimisticLockException

Make a deep copy of the supplied PortalEntity, giving the new object the supplied owning portal, namespace and name. It also calls the PostCopy callback interface after the the object has been copied.

All strong references will be followed and copies made of the referenced entities. Weak references will be copied such that the new objects reference the same entities as the original object. Objects that are copied by following strong references will be given a temporary name unless the object is copied to a new portal, in which case the original name is retained.

The newly created entities will inherit security from the same entities as the corresponding source entities, if any.

Parameters:

source - The PortalEntity to copy.

targetPortal - Portal for the new PortalEntity.

targetNamespace - Namespace for the new PortalEntity.

targetName - Name for the new PortalEntity.

postCopy - the PostCopy callback interface

Returns:

A deep copy of the source PortalEntity, with the specified new name

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

DuplicateNameException

deepCopy

<S extends PortalEntity,T extends PortalEntity> T deepCopy(S source,
                                                           PortalResource targetPortal,
                                                           java.lang.String targetNamespace,
                                                           java.lang.String targetName,
                                                           java.lang.Class<T> targetType)
                                                    throws DuplicateNameException,
                                                           oracle.webcenter.portal.PortalOptimisticLockException

Make a deep copy of the supplied PortalEntity, giving the new object the supplied owning portal, namespace, name, and type.

All strong references will be followed and copies made of the referenced entities. Weak references will be copied such that the new objects reference the same entities as the original object. Objects that are copied by following strong references will be given a temporary name unless the object is copied to a new portal, in which case the original name is retained. Note that only properties and references that the source type and target type have in common will be copied.

The newly created entities will inherit security from the same entities as the corresponding source entities, if any.

Parameters:

source - The PortalEntity to copy.

targetPortal - Portal for the new PortalEntity.

targetNamespace - Namespace for the new PortalEntity.

targetName - Name for the new PortalEntity.

targetType - the type for the new PortalEntity.

Returns:

A deep copy of the source PortalEntity, with the specified new name.

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

DuplicateNameException

deepCopy

<S extends PortalEntity,T extends PortalEntity> T deepCopy(S source,
                                                           PortalResource targetPortal,
                                                           java.lang.String targetNamespace,
                                                           java.lang.String targetName,
                                                           java.lang.Class<T> targetType,
                                                           PostCopy<T> postCopy,
                                                           java.lang.String[] excludedReferenceNames)
                                                    throws DuplicateNameException,
                                                           oracle.webcenter.portal.PortalOptimisticLockException

Make a deep copy of the supplied PortalEntity, giving the new object the supplied owning portal, namespace, name, and type. It also calls the PostCopy callback interface after the the object has been copied.

All strong references will be followed and copies made of the referenced entities. Weak references will be copied such that the new objects reference the same entities as the original object. Objects that are copied by following strong references will be given a temporary name unless the object is copied to a new portal, in which case the original name is retained. Note that only properties and references that the source type and target type have in common will be copied.

The newly created entities will inherit security from the same entities as the corresponding source entities, if any.

Parameters:

source - The PortalEntity to copy.

targetPortal - Portal for the new PortalEntity.

targetNamespace - Namespace for the new PortalEntity.

targetName - Name for the new PortalEntity.

targetType - the type for the new PortalEntity.

postCopy - the PostCopy callback interface

excludedReferenceNames - array of reference names to nullify on the copied object

Returns:

A deep copy of the source PortalEntity, with the specified new name.

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

DuplicateNameException

deepCopy

<S extends PortalEntity,T extends PortalEntity> T deepCopy(S source,
                                                           T target)

Make a deep copy of the supplied source PortalEntity to the supplied target PortalEntity. Note that the name, namspace and portal are not copied.

All strong references will be followed and copies made of the referenced entities. Weak references will be copied such that the new objects reference the same entities as the original object. Objects that are copied by following strong references will be given a temporary name unless the object is copied to a new portal, in which case the original name is retained. Note that only properties and references that the source type and target type have in common will be copied.

The newly created entities will inherit security from the same entities as the corresponding source entities, if any.

Parameters:

source - the source PortalEntity to copy

target - the target PortalEntity to copy to

Returns:

the target

deepCopy

<S extends PortalEntity,T extends PortalEntity> T deepCopy(S source,
                                                           T target,
                                                           PostCopy<T> postCopy)

Make a deep copy of the supplied source PortalEntity to the supplied target PortalEntity. Note that the name, namspace and portal are not copied. It also calls the PostCopy callback interface after the the object has been copied.

All strong references will be followed and copies made of the referenced entities. Weak references will be copied such that the new objects reference the same entities as the original object. Objects that are copied by following strong references will be given a temporary name unless the object is copied to a new portal, in which case the original name is retained. Note that only properties and references that the source type and target type have in common will be copied.

The newly created entities will inherit security from the same entities as the corresponding source entities, if any.

Parameters:

source - the source PortalEntity to copy

target - the target PortalEntity to copy to

postCopy - the PostCopy callback interface

Returns:

the target

getEntitiesForExport

<T extends PortalEntity> java.util.List<T> getEntitiesForExport(PortalEntity entity)

Returns a list of PortalEntities that will be exported when the supplied entity is exported.

Parameters:

entity - The entity to query.

Returns:

A list of PortalEntities that will be exported along with the supplied entity.

exportXML

@Deprecated
org.w3c.dom.Document exportXML(java.util.Set<? extends PortalEntity> entities,
                                           boolean followRefs)
                                    throws PersistenceExportException

Deprecated. Replaced by exportXML(Set, ExportOptions)

Exports a set of PortalEntity objects to an XML document. The export data will also include those PortalEntity objects that are referenced by those in the given set of objects via properties using PersistReference annotations with the export element set to true.

Parameters:

entities - the set of PortalEntity objects to include in the exported data

followRefs - whether or not objects that are referenced by those in the export set should also be included in the exported data

Returns:

an XML document containing the exported data

Throws:

PersistenceExportException - if an error occurs during the creation of export data

exportXML

org.w3c.dom.Document exportXML(java.util.Set<? extends PortalEntity> entities,
                               ExportOptions options)
                        throws PersistenceExportException

Exports a set of PortalEntity objects to an XML document. The export data will also include those PortalEntity objects that are referenced by those in the given set of objects via properties using PersistReference annotations with the export element set to true.

Parameters:

entities - the set of PortalEntity objects to include in the exported data

options - the export options

Returns:

an XML document containing the exported data

Throws:

PersistenceExportException - if an error occurs during the creation of export data

importXML

java.util.Set<PortalEntity> importXML(org.w3c.dom.Document... exportData)
                               throws PersistenceImportException

Imports a set of PortalEntity objects.

Parameters:

exportData - XML documents containing the data to be imported

Returns:

a set of PortalEntity objects corresponding to the data in the given exportData

Throws:

PersistenceImportException - if an error occurs whilst importing the data

importXML

java.util.Set<PortalEntity> importXML(PortalEntity portal,
                                      org.w3c.dom.Document... exportData)
                               throws PersistenceImportException

Imports a set of PortalEntity objects. This method takes a portal object. For import of individual types (page, templates, etc) if the portal id of the objects being imported is not found in the target then the object is imported to the portal specified in this parameter.

Parameters:

portal - the target portal for import

exportData - XML documents containing the data to be imported

Returns:

a set of PortalEntity objects corresponding to the data in the given exportData

Throws:

PersistenceImportException - if an error occurs whilst importing the data

getImportReport

ImportReport getImportReport(org.w3c.dom.Document... exportData)
                      throws PersistenceException

Generates a report on an export set. This method produces an import report, which is a flat list of objects representing a small set of data about the entities within the supplied export set. The relationships between entities are not captured. One application of this data would be to perform validation of the export set against the target persistence manager prior to calling importXML.

Parameters:

exportData - The export set (or sets)

Returns:

A report of the contents of the export set

Throws:

PersistenceException - if the import report could not be generated

registerPersistenceListener

void registerPersistenceListener(PersistenceListener listener)

Register the listener with the PersistenceManager.

Parameters:

listener - the listener

getPersistenceListener

PersistenceListener getPersistenceListener()

Gets the listener from the PersistenceManager. The listener can be used to access and cleanup lists of PortalEntity object ids that have been previously processed for delete by the Persistence and Portal API layers.

Returns:

listener the listener

lock

void lock(PortalEntity entity,
          LockMode lockMode)

Locks a PortalEntity object

Parameters:

entity - the PortalEntity object to lock

lockMode - the lock mode

createAllowed

boolean createAllowed(java.lang.Class<? extends PortalEntity> type,
                      PortalResource 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 PortalResource 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

notifyExternallyModified

void notifyExternallyModified()

Notifies PersistenceManager of changes to the database. This method notifies the PersistenceManager that the underlying database may have been externally changed.

cleanUpPortalResource

void cleanUpPortalResource(PortalResource resource)
                    throws oracle.webcenter.portal.BasePortalRuntimeException

Deletes all the entities related to a portal in the core portal tables

Parameters:

resource - PortalResource instance

Throws:

oracle.webcenter.portal.BasePortalRuntimeException

findSourceIdBySourceAndName

java.util.List<java.lang.String> findSourceIdBySourceAndName(java.lang.String name,
                                                             java.util.List<java.lang.String> sources,
                                                             PaginationRule page)

Find ids of a list persisted objects that are the source of a particular reference

Parameters:

name - the name of the reference

sources - list of acceptable source of the PortalEntityRefObject to find

page - the pagination rule to apply to the results

Returns:

the list of ids