oracle.webcenter.portal.api

Interface PortalInstance

All Superinterfaces:

ManagedPortalObject<PortalInstancePropertyBean>, Portal<PortalInstancePropertyBean>, PortalObject<PortalInstancePropertyBean>, Subscribable

public interface PortalInstance
extends Portal<PortalInstancePropertyBean>

Represents a single Portal instance within the Portal server. PortalInstance are normally created by obtaining a suitable PortalTemplate instance and calling PortalTemplate.copyAsPortal(java.lang.String).

Instances representing existing Portals can be obtained via PortalObjectRepository.

Since:

12.2.1.0.0

Nested Class Summary

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

ManagedPortalObject.ValidateOnCreate, ManagedPortalObject.ValidateOnUpdate

Field Summary

Fields inherited from interface oracle.webcenter.portal.api.Portal

DEFAULT_GROUP_SPACE_NAME, DEFAULT_PORTAL_ID, DEFAULT_PORTAL_NAMESPACE, DEFAULT_PORTAL_TEMPLATE_NAMESPACE

Method Summary

Modifier and Type	Method and Description
PortalTemplate	copyAsPortalTemplate(java.lang.String name) Creates a Portal Template from the Portal.
PortalTemplate	copyAsPortalTemplate(java.lang.String name, java.lang.String displayName, java.lang.String description, PortalTemplateCreationOptions options) Creates a Portal Template from the Portal.
boolean	isSubscriptionEnabled() Whether subscription is enabled for the portal
void	setAccessLevel(boolean isDiscoverable, boolean isPublic) Sets the portal's access level.

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

addToCustomAttributes, addToDeviceGroups, addToMembers, addToMembers, clearCustomAttributes, getAssets, getCustomAttributes, getDeviceGroup, getDeviceGroups, getJavaFormatId, getLockedPages, getLoginFailedPage, getLoginPage, getMember, getMembers, getNavigationRootNode, getNavigationRootNodeId, getOfflinePage, getOverrideSecurityPages, getPageCreationStyle, getPageDrafts, getPagesResourceCatalogId, getPageTemplateId, getPageTemplatesResourceCatalogId, getProperties, getProvisionedServiceIds, getResourceCatalogForGroupSpaceSiteTemplates, getSkin, getSkinId, isDefault, removeFromCustomAttributes, removeFromDeviceGroups, removeFromMembers, removeFromMembers, removeMembersWithRole, setCustomAttributes, setDeviceGroups, setLoginFailedPage, setLoginPage, setNavigationRootNode, setNavigationRootNodeById, setOfflinePage, setPageCreationStyle, setPagesResourceCatalogById, setPageTemplateById, setPageTemplatesResourceCatalogById, setResourceCatalogForGroupSpaceSiteTemplates, setSkin, setSkinById, updateCustomAttribute

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

Method Detail

copyAsPortalTemplate

PortalTemplate copyAsPortalTemplate(java.lang.String name)
                             throws DuplicateNameException,
                                    MemberOperationException

Creates a Portal Template from the Portal.

Parameters:

name - the name for the Portal Template.

Returns:

the Portal Template

Throws:

DuplicateNameException

MemberOperationException

copyAsPortalTemplate

PortalTemplate copyAsPortalTemplate(java.lang.String name,
                                    java.lang.String displayName,
                                    java.lang.String description,
                                    PortalTemplateCreationOptions options)
                             throws DuplicateNameException,
                                    MemberOperationException

Creates a Portal Template from the Portal.

Parameters:

name - the name for the Portal Template.

displayName - the display name for the new portal template

description - the description for the new portal template

options - the options for what to include in the template

Returns:

the Portal Template

Throws:

DuplicateNameException

MemberOperationException

isSubscriptionEnabled

boolean isSubscriptionEnabled()

Whether subscription is enabled for the portal

Returns:

true if subscription is enabled, otherwise false

setAccessLevel

void setAccessLevel(boolean isDiscoverable,
                    boolean isPublic)

Sets the portal's access level. The access level is derived from valid combinations of the discoverable and public properties as follows:

• Public Access Level: isDiscoverable true and isPublic true
• Private Access Level: isDiscoverable true and isPublic false
• Hidden Access Level: isDiscoverable false and isPublic false.

Parameters:

isDiscoverable - value to set the portal's isDiscoverable property to.

isPublic - vale to set the portal's isPublic property to.