oracle.webcenter.portal.api

Interface ManagedPortalObject<B extends PropertyBean>

All Superinterfaces:

PortalObject<B>

All Known Subinterfaces:

Asset<B>, BasePage<B>, ContentItem<B>, ContentPresenterTemplate, Layout, Member, NavigationNode, Page, PageStyle, PageTemplate, Portal<B>, PortalDevice, PortalDeviceAttribute, PortalDeviceGroup, PortalInstance, PortalTemplate, ResourceCatalog, RoleWorkflow, Skin, WorkflowApproval

public interface ManagedPortalObject<B extends PropertyBean>
extends PortalObject<B>

This interface represents an object exposed via the Portal API. This type has an associated PropertyBean subclass that represents the state stored on that object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ManagedPortalObject.ValidateOnCreate Provides the JavaBean validation group that is used to indicate that a validation constraint should be applied during validation of a PropertyBean used to create a ManagedPortalObject.
static interface	ManagedPortalObject.ValidateOnUpdate Provides the JavaBean validation group that is used to indicate that a validation constraint should be applied during validation of a PropertyBean used to update a ManagedPortalObject.

Method Summary

Modifier and Type	Method and Description
<T extends ManagedPortalObject> T	copy(java.lang.String targetName) Make a copy of this portal object, with the supplied name.
<T extends ManagedPortalObject> T	copy(java.lang.String targetName, Portal targetPortal) Make a copy of this portal object, with the supplied name.
void	delete() Permanently delete this portal object.
void	expandProperties(B bean, java.lang.String[] expandParams, java.lang.String[] fieldParams) Expands REST specific fields in a property bean representing the current state of properties on this portal object.
java.util.Set<PortalSecurityAction>	getAuthorizedActions() Returns a Set of actions that the current user is authorized to perform on this object.
java.util.List<ManagedPortalObject>	getDependentPortalObjects() Return a list of portal objects that this portal object requires in order to function correctly.
<T extends ManagedPortalObject> ManagedPortalObjectHolder<T>	getHolder() Returns a Serializableholder object for the current ManagedPortalObjectinstance.
Portal<?>	getPortal() Get the portal that this portal object belongs to, if any.
java.lang.String	getTypeName() Obtains the fully qualified name of the Portal API type that the object implements.
boolean	isCurrent(B bean) Determine whether the supplied bean can be applied to this portal object without triggering a version conflict.
java.util.Set<javax.validation.ConstraintViolation<B>>	isValid(B bean) Determines if the PropertyBean is valid with respect to this ManagedPortalObject.
void	setPortal(Portal portal) Set the portal that this portal object belongs to, or clear it.
void	setProperties(B bean) Update the properties on this portal object.

Methods inherited from interface oracle.webcenter.portal.api.PortalObject

getId, getProperties, getProperties

Method Detail

setProperties

void setProperties(B bean)
            throws oracle.webcenter.portal.PortalOptimisticLockException

Update the properties on this portal object. 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 updated ManagedPortalObject.

Parameters:

bean - the PropertyBean instance representing the new property set to apply to this object.

Throws:

VersionConflictException - if the bean's currentVersionId doesn't match this object's current version.

ValidationException - if the bean's validation constraints are violated.

oracle.webcenter.portal.PortalAuthorizationException - if the object is secured and the current user does not have permission to update it

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

expandProperties

void expandProperties(B bean,
                      java.lang.String[] expandParams,
                      java.lang.String[] fieldParams)

Expands REST specific fields in a property bean representing the current state of properties on this portal object.

Parameters:

bean - the Bean to be expanded/populated

expandParams - list of parameters to expand. include "all" for all.

fieldParams - list of fields to display/hide or load [not implemented yet]

isCurrent

boolean isCurrent(B bean)

Determine whether the supplied bean can be applied to this portal object without triggering a version conflict.

Returns:

true if the supplied bean can be applied to this object, false if there is a version mismatch.

isValid

java.util.Set<javax.validation.ConstraintViolation<B>> isValid(B bean)

Determines if the PropertyBean is valid with respect to this ManagedPortalObject. Validity is determined be evaluating the javax.validation.ConstraintValidator that are specified via annotations on the PropertyBean.

Parameters:

bean - the PropertyBean to validated

Returns:

The set of constraint violations or the empty set if no violations occured.

delete

void delete()
     throws oracle.webcenter.portal.PortalOptimisticLockException

Permanently delete this portal object.

Throws:

oracle.webcenter.portal.PortalAuthorizationException - if the object 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 ManagedPortalObject> T copy(java.lang.String targetName)
                                throws DuplicateNameException,
                                       oracle.webcenter.portal.PortalOptimisticLockException

Make a copy of this portal object, with the supplied name.

Parameters:

targetName - Name for the new portal object.

Returns:

A copy of this portal object, with the specified new name.

Throws:

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

DuplicateNameException

copy

<T extends ManagedPortalObject> T copy(java.lang.String targetName,
                                       Portal targetPortal)
                                throws DuplicateNameException,
                                       oracle.webcenter.portal.PortalOptimisticLockException

Make a copy of this portal object, with the supplied name.

Parameters:

targetName - Name for the new portal object.

Returns:

A copy of this portal object, with the specified new name.

Throws:

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

DuplicateNameException

getPortal

Portal<?> getPortal()

Get the portal that this portal object belongs to, if any.

Returns:

the portal this portal object belongs to, or null.

setPortal

void setPortal(Portal portal)
        throws oracle.webcenter.portal.PortalOptimisticLockException

Set the portal that this portal object belongs to, or clear it.

Parameters:

portal - The portal that this object belongs to, or null to clear.

Throws:

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

getDependentPortalObjects

java.util.List<ManagedPortalObject> getDependentPortalObjects()

Return a list of portal objects that this portal object requires in order to function correctly. This list can be used to determine a list of objects that should be exported along with the current object. Objects are returned in the order that they are visited during a depth first traversal of the reference graph.

Returns:

List of dependent ManagedPortalObjects

getAuthorizedActions

java.util.Set<PortalSecurityAction> getAuthorizedActions()

Returns a Set of actions that the current user is authorized to perform on this object.

Returns:

the actions that the current user can perform on this object

getTypeName

java.lang.String getTypeName()

Obtains the fully qualified name of the Portal API type that the object implements.

Returns:

the name of the Portal API type of this object

getHolder

<T extends ManagedPortalObject> ManagedPortalObjectHolder<T> getHolder()

Returns a Serializableholder object for the current ManagedPortalObjectinstance.

Returns:

a holder object for the current instance.

See Also:

ManagedPortalObjectHolder