oracle.webcenter.portal.api.event

Interface PortalEvent

public interface PortalEvent

An event fired as a result of an operation on a portal

Method Summary

Modifier and Type	Method and Description
Operation	getOperation() Gets the operation being performed
java.lang.String	getPortalDescription() Gets the description of the portal
java.lang.String	getPortalDisplayName() Gets the display name of the portal
java.lang.String	getPortalId() Gets the ID of the portal
java.lang.String	getPortalName() Gets the name of the portal
PortalTemplateCreationOptions	getPortalTemplateCreationOptions() Gets the portal template creation options.
java.lang.String	getSourcePortalName() Gets the name of the source portal.
boolean	isPublic() Whether the portal is public
boolean	isTemplate() Whether the event is for a portal template

Method Detail

getOperation

Operation getOperation()

Gets the operation being performed

Returns:

the operation

getPortalId

java.lang.String getPortalId()

Gets the ID of the portal

Returns:

the ID of the portal

getPortalName

java.lang.String getPortalName()

Gets the name of the portal

Returns:

the name of the portal

getPortalDisplayName

java.lang.String getPortalDisplayName()

Gets the display name of the portal

Returns:

the displayName of the portal

getPortalDescription

java.lang.String getPortalDescription()

Gets the description of the portal

Returns:

the description of the portal

getSourcePortalName

java.lang.String getSourcePortalName()

Gets the name of the source portal. This is only applicable for a copy operation and in all other cases should return null.

Returns:

the name of the source portal, or null if this is not an event for a copy operation

isTemplate

boolean isTemplate()

Whether the event is for a portal template

Returns:

true if the event is for a portal template, otherwise false

isPublic

boolean isPublic()

Whether the portal is public

Returns:

true if the portal is public, otherwise false

getPortalTemplateCreationOptions

PortalTemplateCreationOptions getPortalTemplateCreationOptions()

Gets the portal template creation options. For most events this will be null and should only be populated for a portal copy event (Operation.COPY) where the source is a portal template

Returns:

the portal template creation options or null if not applicable