oracle.webcenter.portal.persistence

Interface PortalEntity

All Known Subinterfaces:

ADFPageResource, AssetCollectionResource, AssetResource, AttributeEntity, BasePageResource, BaseTaskFlowResource, BusinessObjectEntity, ContentItemResource, ContentPresenterTemplateResource, DataProviderEntity, DataServiceEntity, DeploymentEntity, DeviceAttributeResource, DeviceGroupResource, DeviceResource, DpTaskFlowResource, FileResource, ImageContentItemResource, LayoutResource, ManagedResource, MemberResource, NameValueResource, NavigationNodeResource, PageCollectionResource, PageDefinitionResource, PageResource, PageStyleResource, PageTemplateResource, PageViewResource, ParameterEntity, PortalDeploymentEntity, PortalInstanceResource, PortalResource, PortalTemplateResource, ResourceCatalogResource, RESTDataServiceEntity, RoleWorkflowResource, SharedAssetsDeploymentEntity, SharedLibDeploymentEntity, SkinResource, SOAPDataServiceEntity, SQLDataServiceEntity, TaskFlowResource, TextContentItemResource, VisualizationTemplateResource, WorkflowApprovalResource

@AbstractEntity
public interface PortalEntity

Interface that is implemented by all types that represent data persisted by the Portal.

In addition to extending the PortalEntity interface, interfaces that represent types that form the persistence model must use the PersistProperty annotation to denote persisted properties and PersistReference to denote references to other PortalEntitys in the model.

The AbstractEntity annotation is used to indicate that a model type is abstract and cannot be created or queried directly using a PersistenceManager.

See Also:

PersistenceManager

Method Summary

Modifier and Type	Method and Description
java.util.Set<PersistenceSecurityAction>	getAuthorizedActions() Returns the set actions that the current user is authorized to perform on this object.
java.util.Date	getCreated() Gets the date/time the entity was created
java.lang.String	getCreator() Gets the creator of the entity
java.lang.String	getDescription() Gets the description
java.lang.String	getDocumentRef() Gets the document reference
java.lang.String	getId() Gets the ID of the entity
boolean	getIsInitialized() Gets the flag indicating whether this object has been fully initialized.
boolean	getIsSecured() Gets the flag indicating whether this object has been secured.
boolean	getIsSeeded() Whether the object is a seeded object
java.util.Date	getModified() Gets the date/time the entity was last modified
java.lang.String	getModifier() Gets the user that last modified the entity
java.lang.String	getName() Gets the name of the entity
java.lang.String	getNamespace() Gets the namespace of this entity.
PortalResource	getPortal() Gets the entity representing the portal that owns this entity, if any.
PortalEntity	getRootSecurityEntity() Obtains the entity that this entity ultimately inherits its security ID from.
PortalEntity	getSecurityEntity() Obtains the entity that this entity immediately inherits its security ID from.
java.lang.String	getSecurityId() Obtains the security ID being used by this entity.
java.lang.String	getShortId() Gets the short ID of the entity.
java.lang.String	getType() Gets the model interface type of this entity.
java.lang.String	getVersionId() Gets the version ID
boolean	inheritsSecurity() Returns true if this entity inherits its security ID from another entity.
void	lock(LockMode lockMode) Locks the portal entity
void	setCreated(java.util.Date created) Sets the date/time the entity was created
void	setCreator(java.lang.String creator) Sets the creator of the entity
void	setDescription(java.lang.String description) Sets the description
void	setDocumentRef(java.lang.String documentRef) Sets the document reference
void	setIsInitialized(boolean initialized) Sets the flag indicating whether this object has been fully initialized.
void	setIsSeeded(boolean seeded) Sets whether the object is a seeded object
void	setName(java.lang.String name) Sets the name of the entity
void	setNamespace(java.lang.String namespace) Sets the namespace of the entity
void	setPortal(PortalResource portal) Sets the owning portal entity.
void	setSecurityEntity(PortalEntity pe) Sets the entity from which this entity should inherit its security ID from.
void	setSecurityId(java.lang.String securityId) Explicitly sets the security ID for this entity.
void	setVersionId(java.lang.String versionId) Sets the version ID

Method Detail

getId

java.lang.String getId()

Gets the ID of the entity

Returns:

the ID

getShortId

java.lang.String getShortId()

Gets the short ID of the entity. This uniquely identifies the entity on this portal instance.

Returns:

the short ID

getType

java.lang.String getType()

Gets the model interface type of this entity.

Returns:

the model interface classname as a string

getName

java.lang.String getName()

Gets the name of the entity

Returns:

the name of the entity

setName

void setName(java.lang.String name)

Sets the name of the entity

Parameters:

name - the name of the entity

getNamespace

java.lang.String getNamespace()

Gets the namespace of this entity. The combination of (portalId, namespace, name) uniquely identifies an entity on the portal server.

Returns:

the namespace

setNamespace

void setNamespace(java.lang.String namespace)

Sets the namespace of the entity

Parameters:

namespace - the namespace

getRootSecurityEntity

PortalEntity getRootSecurityEntity()

Obtains the entity that this entity ultimately inherits its security ID from. Will return this entity if inheritsSecurity() returns false.

Returns:

the PortalEntity that defines this entity's security ID

getSecurityEntity

PortalEntity getSecurityEntity()

Obtains the entity that this entity immediately inherits its security ID from. Will return this entity if inheritsSecurity() returns false.

Returns:

the PortalEntity that this entity inherits its security ID from

setSecurityEntity

void setSecurityEntity(PortalEntity pe)

Sets the entity from which this entity should inherit its security ID from. Once this method has been invoked, inheritsSecurity() will return true.

Parameters:

pe - the PortalEntity from which this entity will inherit a security ID

getSecurityId

java.lang.String getSecurityId()

Obtains the security ID being used by this entity. This could be inherited from another entity if inheritsSecurity() returns true.

Returns:

the security id

setSecurityId

void setSecurityId(java.lang.String securityId)

Explicitly sets the security ID for this entity. If this entity is currently inheriting a security ID from another entity (i.e. inheritsSecurity() returns true) then that relationship will be removed when this method is invoked and inheritsSecurity() will subsequently return false.

Parameters:

securityId - the security id

inheritsSecurity

boolean inheritsSecurity()

Returns true if this entity inherits its security ID from another entity.

getDescription

java.lang.String getDescription()

Gets the description

Returns:

the description

setDescription

void setDescription(java.lang.String description)

Sets the description

Parameters:

description - the description

getVersionId

java.lang.String getVersionId()

Gets the version ID

Returns:

the version ID

setVersionId

void setVersionId(java.lang.String versionId)

Sets the version ID

Parameters:

versionId - the version ID

getDocumentRef

java.lang.String getDocumentRef()

Gets the document reference

Returns:

the document reference

setDocumentRef

void setDocumentRef(java.lang.String documentRef)

Sets the document reference

Parameters:

documentRef - the document reference

getCreator

java.lang.String getCreator()

Gets the creator of the entity

Returns:

the creator

setCreator

void setCreator(java.lang.String creator)

Sets the creator of the entity

Parameters:

creator - the creator

getCreated

java.util.Date getCreated()

Gets the date/time the entity was created

Returns:

the date/time the entity was created

setCreated

void setCreated(java.util.Date created)

Sets the date/time the entity was created

Parameters:

created - the date/time the entity was created

getModifier

java.lang.String getModifier()

Gets the user that last modified the entity

Returns:

the user that last modified the entity

getModified

java.util.Date getModified()

Gets the date/time the entity was last modified

Returns:

the date/time the entity was last modified

getIsInitialized

boolean getIsInitialized()

Gets the flag indicating whether this object has been fully initialized. This is typically used to indicate whether any external artifacts associated with this entity have been created.

Returns:

value of the initialized flag

setIsInitialized

void setIsInitialized(boolean initialized)

Sets the flag indicating whether this object has been fully initialized. This is typically called to set the flag once any associated artifacts for this entity have been created.

Parameters:

initialized - new value of the initialized flag

getIsSeeded

boolean getIsSeeded()

Whether the object is a seeded object

Returns:

true if it is seeded, otherwise false

setIsSeeded

void setIsSeeded(boolean seeded)

Sets whether the object is a seeded object

Parameters:

seeded - true if it is seeded, otherwise false

getPortal

PortalResource getPortal()

Gets the entity representing the portal that owns this entity, if any.

Returns:

The owning portal, or null if entity has no owning portal

setPortal

void setPortal(PortalResource portal)

Sets the owning portal entity.

Parameters:

portal - The owning portal

getAuthorizedActions

java.util.Set<PersistenceSecurityAction> getAuthorizedActions()

Returns the set actions that the current user is authorized to perform on this object.

The set of actions will be a subset of those specified via the Authorization.actions() element of the Authorization annotation on the this object's class. If no Authorization annotation is specified then the object is considered not to be secured and a full set of actions will be returned.

Returns:

the actions that the current user can perform on this object

getIsSecured

boolean getIsSecured()

Gets the flag indicating whether this object has been secured. The object is secured if it has a non-null security ID associated with it.

Returns:

value of the secured flag

lock

void lock(LockMode lockMode)

Locks the portal entity

Parameters:

lockMode - the lock mode