oracle.webcenter.portal.api

Interface PortalTemplate

All Superinterfaces:

ManagedPortalObject<PortalTemplatePropertyBean>, Portal<PortalTemplatePropertyBean>, PortalObject<PortalTemplatePropertyBean>, Subscribable

public interface PortalTemplate
extends Portal<PortalTemplatePropertyBean>

Portal API type representing a Portal template.

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
PortalInstance	copyAsPortal(java.lang.String name) Creates a Portal Instance from the Portal Template.
PortalInstance	copyAsPortal(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.String keywords) Creates a Portal Instance from the Portal Template.
java.util.List<Member>	getProtoMembers() Gets the proto-members of the portal template which will be used to create the members of a portal instance created from the template.

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

copyAsPortal

PortalInstance copyAsPortal(java.lang.String name)
                     throws DuplicateNameException,
                            NullNameException,
                            MemberOperationException

Creates a Portal Instance from the Portal Template.

Parameters:

name - the name for the Portal Instance

Returns:

the newly created Portal Instance

Throws:

DuplicateNameException

NullNameException

MemberOperationException

copyAsPortal

PortalInstance copyAsPortal(java.lang.String name,
                            java.lang.String displayName,
                            java.lang.String description,
                            java.lang.String keywords)
                     throws DuplicateNameException,
                            NullNameException,
                            MemberOperationException

Creates a Portal Instance from the Portal Template.

Parameters:

name - the name for the Portal Instance

displayName - the display name for the new Portal Instance

description - the description for the new Portal Instance

keywords - the keywords for the new Portal Instance

Returns:

the newly created Portal Instance

Throws:

DuplicateNameException

NullNameException

MemberOperationException

getProtoMembers

java.util.List<Member> getProtoMembers()

Gets the proto-members of the portal template which will be used to create the members of a portal instance created from the template.

Returns:

the proto-members