public interface ITemplateService
Modifier and Type | Method and Description |
---|---|
boolean |
assignTemplates(ICollection collection,
ITemplateList templateList,
ITemplate template,
IProfileList profileList,
IProfile profile,
boolean asSubmenu)
Assigns Single Templates and Template Groups to a collection.
|
boolean |
canAssignGlobalTemplates(ICollection collection)
Returns whether the current user has the permission to assign templates to the
given collection or not
|
boolean |
canAssignTemplates(ICollection collection)
This method is not supported yet and will be forwarded to
the method canAssignGlobalTemplates
|
IResource |
createFromTemplate(ICollection collection,
ITemplate template)
Creates a new item out of the
ITemplate and stores it
in the given collection. |
IProfileList |
getAssignedProfiles(ICollection collection)
Returns the assigned groups for the given collection
|
ITemplateList |
getAssignedSingleTemplates(ICollection collection)
Returns the assigned templates for the given collection
|
IProfileList |
getEmptyProfileList()
Returns an empty template group list
|
ITemplateList |
getEmptyTemplateList()
Returns an empty template list
|
IProfile |
getProfile(String id,
IResourceContext resourceContext)
Returns the group for the given id and resource context
|
IProfileList |
getProfiles(ICollection collection)
Returns all template groups which could be assigned to the given collection.
|
RID |
getProfilesStoragePath()
Returns the
RID of the collection where all available groups are stored |
ITemplateList |
getSingleTemplates(ICollection collection)
Returns all templates which could be assigned to the given collection.
|
ITemplate |
getTemplate(String id,
IResourceContext resourceContext)
Returns the single template for the given id and resource context
|
RID |
getTemplatesStoragePath()
Returns the
RID of the collection where all available single templates are stored |
boolean |
isAssignedAsSubmenu(ICollection collection)
Returns whether the groups should be rendered as sub menus or not
|
boolean |
isAvailable(ICollection collection)
Returns whether the template service is available for the given collection or not
|
ITemplateList |
resolveProfiles(IProfileList profileList,
IProfile profile,
IResourceContext context)
Resolves the given and all included template groups to its single templates
|
boolean assignTemplates(ICollection collection, ITemplateList templateList, ITemplate template, IProfileList profileList, IProfile profile, boolean asSubmenu) throws NotAuthorizedException
collection
- The collection for which the templates should be assignedtemplateList
- ITemplateList
that should be assignedtemplate
- ITemplate
that should be assignedprofileList
- IProfileList
that should be assignedprofile
- IProfile
that should be assignedasSubmenu
- If this parameter is set, the assigned template groups opens in a own menuNotAuthorizedException
- if an error occurredITemplateList getSingleTemplates(ICollection collection)
collection
- Collection for which all possible single templates should be returnedITemplateList
that contains a list of single templatesIProfileList getProfiles(ICollection collection)
collection
- Collection for which all possible template groups should be returnedIProfileList
that contains a list of all possible groupsITemplateList getAssignedSingleTemplates(ICollection collection)
collection
- Collection for which the assigned templates should be returnedITemplateList
that contains a list of single templatesIProfileList getAssignedProfiles(ICollection collection)
collection
- Collection for which the assigned template groups should be returnedIProfileList
that contains a list of template groupsboolean isAssignedAsSubmenu(ICollection collection)
collection
- Collection for which the flag should be returnedboolean isAvailable(ICollection collection)
collection
- Collection to checkITemplateList resolveProfiles(IProfileList profileList, IProfile profile, IResourceContext context)
profileList
- IProfileList
that should be resolvedprofile
- IProfile
that should be resolvedcontext
- Resource Context Current resource contextITemplateList
that contains a list of all single templates
which are contained in the given template groupsboolean canAssignTemplates(ICollection collection)
collection
- Collection to checkboolean canAssignGlobalTemplates(ICollection collection)
collection
- Collection to checkIResource createFromTemplate(ICollection collection, ITemplate template) throws WcmException, NotAuthorizedException
ITemplate
and stores it
in the given collection. The new item is a copy of the given template.collection
- Collection underneath the new item will be storedtemplate
- ITemplate
from which a new item should be createdWcmException
- if an error occurredNotAuthorizedException
- if an error occurredITemplateList getEmptyTemplateList()
ITemplateList
IProfileList getEmptyProfileList()
IProfileList
IProfile getProfile(String id, IResourceContext resourceContext) throws ProfileNotFoundException, NotAuthorizedException
id
- ID of the groupresourceContext
- resource contextIProfile
for the given id and contextProfileNotFoundException
- if an error occurredNotAuthorizedException
- if an error occurredITemplate getTemplate(String id, IResourceContext resourceContext) throws TemplateNotFoundException, NotAuthorizedException
id
- ID of the single templateresourceContext
- resource contextITemplate
for the given id and contextTemplateNotFoundException
- if an error occurredNotAuthorizedException
- if an error occurredRID getProfilesStoragePath()
RID
of the collection where all available groups are storedRID getTemplatesStoragePath()
RID
of the collection where all available single templates are storedAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice