oracle.webcenter.portal.api

Interface Portal<B extends PortalPropertyBean>

All Superinterfaces:

ManagedPortalObject<B>, PortalObject<B>, Subscribable

All Known Subinterfaces:

PortalInstance, PortalTemplate

public interface Portal<B extends PortalPropertyBean>
extends ManagedPortalObject<B>, Subscribable

Provides the base Portal API type representing portal instances and templates. The Portal type is logically abstract. Use the PortalObjectRepository to obtain an instance of a suitable subtype such as PortalInstance or PortalTemplate.

Since:

12.2.1.0.0

See Also:

PortalInstance, PortalTemplate

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.webcenter.portal.api.ManagedPortalObject

ManagedPortalObject.ValidateOnCreate, ManagedPortalObject.ValidateOnUpdate

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_GROUP_SPACE_NAME
static java.lang.String	DEFAULT_PORTAL_ID
static java.lang.String	DEFAULT_PORTAL_NAMESPACE
static java.lang.String	DEFAULT_PORTAL_TEMPLATE_NAMESPACE

Method Summary

Modifier and Type	Method and Description
void	addToCustomAttributes(java.lang.String key, java.lang.String value) Add a custom attribute.
void	addToDeviceGroups(PortalDeviceGroup group) Adds the given device group to device groups of this portal
void	addToMembers(Member member) Adds a member to the Portal's members.
void	addToMembers(java.lang.String identity, boolean isEntrRole, java.lang.String roleName) Creates and adds a member/role to the Portal using the information passed in by the parameters.
void	clearCustomAttributes() Clear all custom attributes.
java.util.List<Asset>	getAssets() Gets a list of assets owned by this Portal.
java.util.Map<java.lang.String,java.lang.String>	getCustomAttributes() Get the map of custom attributes.
PortalDeviceGroup	getDeviceGroup(java.lang.String name) Gets the device group of this portal
java.util.List<PortalDeviceGroup>	getDeviceGroups() Gets the device groups for this portal
java.lang.String	getJavaFormatId() Get the Portal Id in Java identifier format.
java.util.List<Page>	getLockedPages() Gets a list of locked pages owned by this Portal.
Page	getLoginFailedPage() Gets the login failed page.
Page	getLoginPage() Gets the login page.
Member	getMember(java.lang.String identity, boolean isEntRole, java.lang.String role) Returns a member given the passed in attributes if the member exists, otherwise null will be returned.
java.util.List<Member>	getMembers() Returns a list of the Members added to the Portal.
NavigationNode	getNavigationRootNode() Gets the navigation root node.
java.lang.String	getNavigationRootNodeId() Get the Id of the navigation root node of the portal.
Page	getOfflinePage() Gets the offline page.
java.util.List<Page>	getOverrideSecurityPages() Gets a list of pages owned by this Portal that override security
PageStyle	getPageCreationStyle() Gets the page creation style.
java.util.List<Page>	getPageDrafts() Gets a list of page drafts owned by this Portal.
java.lang.String	getPagesResourceCatalogId() Gets the Id of the pages resource catalog of the portal.
java.lang.String	getPageTemplateId() Get the Id of the page template of the portal.
java.lang.String	getPageTemplatesResourceCatalogId() Gets the Id of the page templates resource catalog of the portal.
B	getProperties() Get a property bean representing the current state of properties on this portal object.
java.util.List<java.lang.String>	getProvisionedServiceIds() Gets the list of Provisioned Service Ids.
ResourceCatalog	getResourceCatalogForGroupSpaceSiteTemplates() Gets the resource catalog for group space site templates.
Skin	getSkin() Gets the skin.
java.lang.String	getSkinId() Get the Id of the skin of the portal.
boolean	isDefault() Whether the portal is the default portal
void	removeFromCustomAttributes(java.lang.String key) Remove a custom attribute.
void	removeFromDeviceGroups(PortalDeviceGroup group) Removes the given device group for list of device groups for this portal
void	removeFromMembers(Member member) Removes a member from the Portal's members.
void	removeFromMembers(java.lang.String identity, boolean isEntRole, java.lang.String roleName) Removes a member from the Portal using the information passed in.
void	removeMembersWithRole(java.lang.String roleName) Removes all members with the given role from the Portal.
void	setCustomAttributes(java.util.Map<java.lang.String,java.lang.String> customAttributes) Set the map of custom attributes.
void	setDeviceGroups(java.util.List<PortalDeviceGroup> groupList) Sets the device groups for this portal
void	setLoginFailedPage(Page loginFailedPage) Sets the login failed page.
void	setLoginPage(Page loginPage) Sets the login page.
void	setNavigationRootNode(NavigationNode rootNode) Sets the navigation root node.
void	setNavigationRootNodeById(java.lang.String id) Set the navigation root node of the portal by the Id of the navigation node.
void	setOfflinePage(Page offlinePage) Sets the offline page.
void	setPageCreationStyle(PageStyle pageStyle) Sets the page style.
void	setPagesResourceCatalogById(java.lang.String id) Sets the pages resource catalog of the portal by the Id of the resource catalog.
void	setPageTemplateById(java.lang.String id) Set the page template of the portal by the Id of the page template.
void	setPageTemplatesResourceCatalogById(java.lang.String id) Sets the page templates resource catalog of the portal by the Id of the resource catalog.
void	setResourceCatalogForGroupSpaceSiteTemplates(ResourceCatalog rc) Sets the resource catalog for group space site templates.
void	setSkin(Skin skin) Sets the skin.
void	setSkinById(java.lang.String id) Set the skin of the portal by the Id of the skin.
void	updateCustomAttribute(java.lang.String key, java.lang.String value) Update a custom attribute.

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

copy, copy, delete, expandProperties, getAuthorizedActions, getDependentPortalObjects, getHolder, getPortal, getTypeName, isCurrent, isValid, setPortal, setProperties

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

getId, getProperties

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

getSubscriptionApproval, getUnsubscriptionApproval

Field Detail

DEFAULT_PORTAL_NAMESPACE

static final java.lang.String DEFAULT_PORTAL_NAMESPACE

See Also:

Constant Field Values

DEFAULT_PORTAL_TEMPLATE_NAMESPACE

static final java.lang.String DEFAULT_PORTAL_TEMPLATE_NAMESPACE

See Also:

Constant Field Values

DEFAULT_GROUP_SPACE_NAME

static final java.lang.String DEFAULT_GROUP_SPACE_NAME

See Also:

Constant Field Values

DEFAULT_PORTAL_ID

static final java.lang.String DEFAULT_PORTAL_ID

See Also:

Constant Field Values

Method Detail

getProperties

B getProperties()

Get a property bean representing the current state of properties on this portal object.

Specified by:

getProperties in interface PortalObject<B extends PortalPropertyBean>

Returns:

A PropertyBean instance representing the current state of this portal object.

getJavaFormatId

java.lang.String getJavaFormatId()

Get the Portal Id in Java identifier format.

Returns:

the Portal Id in Java identifier format.

getNavigationRootNode

NavigationNode getNavigationRootNode()

Gets the navigation root node.

Returns:

the navigation root node

setNavigationRootNode

void setNavigationRootNode(NavigationNode rootNode)

Sets the navigation root node.

Parameters:

rootNode - the new navigation root node

getLoginPage

Page getLoginPage()

Gets the login page.

Returns:

the login page

setLoginPage

void setLoginPage(Page loginPage)

Sets the login page.

Parameters:

loginPage - the new login page

getLoginFailedPage

Page getLoginFailedPage()

Gets the login failed page.

Returns:

the login failed page

setLoginFailedPage

void setLoginFailedPage(Page loginFailedPage)

Sets the login failed page.

Parameters:

loginFailedPage - the new login failed page

getOfflinePage

Page getOfflinePage()

Gets the offline page.

Returns:

the offline page

setOfflinePage

void setOfflinePage(Page offlinePage)

Sets the offline page.

Parameters:

offlinePage - the new offline page

getResourceCatalogForGroupSpaceSiteTemplates

ResourceCatalog getResourceCatalogForGroupSpaceSiteTemplates()

Gets the resource catalog for group space site templates.

Returns:

the resource catalog for group space site templates

setResourceCatalogForGroupSpaceSiteTemplates

void setResourceCatalogForGroupSpaceSiteTemplates(ResourceCatalog rc)

Sets the resource catalog for group space site templates.

Parameters:

rc - the new resource catalog for group space site templates

getPageCreationStyle

PageStyle getPageCreationStyle()

Gets the page creation style.

Returns:

the page creation style

setPageCreationStyle

void setPageCreationStyle(PageStyle pageStyle)

Sets the page style.

Parameters:

pageStyle - the new page style

getSkin

Skin getSkin()

Gets the skin.

Returns:

the skin

setSkin

void setSkin(Skin skin)

Sets the skin.

Parameters:

skin - the new skin

getAssets

java.util.List<Asset> getAssets()

Gets a list of assets owned by this Portal.

Returns:

list of assets.

getMembers

java.util.List<Member> getMembers()

Returns a list of the Members added to the Portal. Note Member is a combination of unique User Id and role, hence there will be a Member per role and user, as a result the count can be larger than the distinct user identies added to the Portal, when some users have multiple roles.

Returns:

the list of members.

getMember

Member getMember(java.lang.String identity,
                 boolean isEntRole,
                 java.lang.String role)

Returns a member given the passed in attributes if the member exists, otherwise null will be returned.

Parameters:

identity - The user id to look up.

isEntRole - Whether the user id is an enterprise role or not.

role - The role being looked up.

Returns:

the member associated with the query parameters, otherwise null.

addToMembers

void addToMembers(Member member)

Adds a member to the Portal's members.

Parameters:

member - The member to add to the Portal.

addToMembers

void addToMembers(java.lang.String identity,
                  boolean isEntrRole,
                  java.lang.String roleName)
           throws MemberOperationException

Creates and adds a member/role to the Portal using the information passed in by the parameters.

Parameters:

identity - The users identity.

roleName - The role name.

isEntrRole - Whether or not this is an enterprise role.

Throws:

MemberOperationException - if there is an error adding the member.

removeFromMembers

void removeFromMembers(Member member)

Removes a member from the Portal's members.

Parameters:

member - the member to remove.

removeFromMembers

void removeFromMembers(java.lang.String identity,
                       boolean isEntRole,
                       java.lang.String roleName)
                throws MemberOperationException

Removes a member from the Portal using the information passed in.

Parameters:

identity - The member's identity.

isEntRole - Whether or not the identity is an enterprise role.

roleName - The member's role name.

Throws:

MemberOperationException - if any error occurs on removing the member.

removeMembersWithRole

void removeMembersWithRole(java.lang.String roleName)
                    throws MemberOperationException

Removes all members with the given role from the Portal.

Parameters:

roleName - The role name.

Throws:

MemberOperationException - if any error occurs on removing the matching members.

getPageDrafts

java.util.List<Page> getPageDrafts()

Gets a list of page drafts owned by this Portal. TODO: If this API called often, model an one-to-many relationship from portal to draft page in PortalResource.

Returns:

list of page drafts.

getOverrideSecurityPages

java.util.List<Page> getOverrideSecurityPages()

Gets a list of pages owned by this Portal that override security

Returns:

list of pages that override security

getLockedPages

java.util.List<Page> getLockedPages()

Gets a list of locked pages owned by this Portal.

Returns:

list of pages that are locked.

getCustomAttributes

java.util.Map<java.lang.String,java.lang.String> getCustomAttributes()

Get the map of custom attributes.

Returns:

the map of custom attributes.

setCustomAttributes

void setCustomAttributes(java.util.Map<java.lang.String,java.lang.String> customAttributes)

Set the map of custom attributes.

Parameters:

customAttributes - map of custom attributes

addToCustomAttributes

void addToCustomAttributes(java.lang.String key,
                           java.lang.String value)

Add a custom attribute.

Parameters:

key - of the custom attribute

value - of the custom attribute

updateCustomAttribute

void updateCustomAttribute(java.lang.String key,
                           java.lang.String value)

Update a custom attribute.

Parameters:

key - of the custom attribute

value - new value of the custom attribute

removeFromCustomAttributes

void removeFromCustomAttributes(java.lang.String key)

Remove a custom attribute.

Parameters:

key - of the custom attribute

clearCustomAttributes

void clearCustomAttributes()

Clear all custom attributes.

getPageTemplateId

java.lang.String getPageTemplateId()

Get the Id of the page template of the portal.

Returns:

the id of the page template of the portal

setPageTemplateById

void setPageTemplateById(java.lang.String id)

Set the page template of the portal by the Id of the page template.

Parameters:

id - of the page template

getSkinId

java.lang.String getSkinId()

Get the Id of the skin of the portal.

Returns:

the id of the skin of the portal

setSkinById

void setSkinById(java.lang.String id)

Set the skin of the portal by the Id of the skin.

Parameters:

id - of the skin

getNavigationRootNodeId

java.lang.String getNavigationRootNodeId()

Get the Id of the navigation root node of the portal.

Returns:

the id of the navigation root node of the portal

setNavigationRootNodeById

void setNavigationRootNodeById(java.lang.String id)

Set the navigation root node of the portal by the Id of the navigation node.

Parameters:

id - of the navigation root node

getPagesResourceCatalogId

java.lang.String getPagesResourceCatalogId()

Gets the Id of the pages resource catalog of the portal.

Returns:

the id of the pages esource catalog of the portal.

setPagesResourceCatalogById

void setPagesResourceCatalogById(java.lang.String id)

Sets the pages resource catalog of the portal by the Id of the resource catalog.

Parameters:

id - of the resource catalog

getPageTemplatesResourceCatalogId

java.lang.String getPageTemplatesResourceCatalogId()

Gets the Id of the page templates resource catalog of the portal.

Returns:

the id of the page templates esource catalog of the portal.

setPageTemplatesResourceCatalogById

void setPageTemplatesResourceCatalogById(java.lang.String id)

Sets the page templates resource catalog of the portal by the Id of the resource catalog.

Parameters:

id - of the resource catalog

isDefault

boolean isDefault()

Whether the portal is the default portal

Returns:

true if the portal is the default portal

getDeviceGroups

java.util.List<PortalDeviceGroup> getDeviceGroups()

Gets the device groups for this portal

Returns:

the list of device groups for this portal

setDeviceGroups

void setDeviceGroups(java.util.List<PortalDeviceGroup> groupList)

Sets the device groups for this portal

Parameters:

groupList - list of device groups

addToDeviceGroups

void addToDeviceGroups(PortalDeviceGroup group)

Adds the given device group to device groups of this portal

Parameters:

group - to be added to device group list

removeFromDeviceGroups

void removeFromDeviceGroups(PortalDeviceGroup group)

Removes the given device group for list of device groups for this portal

Parameters:

group - to be removed from the device group list

getDeviceGroup

PortalDeviceGroup getDeviceGroup(java.lang.String name)

Gets the device group of this portal

Parameters:

name - of the device group to be returned

Returns:

Device Group with the given name

getProvisionedServiceIds

java.util.List<java.lang.String> getProvisionedServiceIds()

Gets the list of Provisioned Service Ids.

Returns:

The list of service ids