com.sapportals.wcm.service.template

Interface IProfile

All Superinterfaces:

ITemplate

public interface IProfile
extends ITemplate

Method Summary

boolean	containsTemplate(ITemplate template) Checks if the group contains the given template
String	getDescription() Returns the description of the template group
String	getID() Returns the ID of the group
String	getName() Returns the name of the template group
ICollection	getStorageCollection(IResourceContext context) Returns the physical collection that servers as a container for this template group.
ITemplateList	resolveProfile(IResourceContext context, boolean resolveSubprofiles) Returns all templates contained in this group.

Methods inherited from interface com.sapportals.wcm.service.template.ITemplate

isProfile, isUserTemplate

Method Detail

getName

String getName()

Returns the name of the template group

Specified by:

getName in interface ITemplate

Returns:

The name of the group

getDescription

String getDescription()

Returns the description of the template group

Specified by:

getDescription in interface ITemplate

Returns:

The description of the group

getID

String getID()

Returns the ID of the group

Specified by:

getID in interface ITemplate

Returns:

The ID of the group

getStorageCollection

ICollection getStorageCollection(IResourceContext context)
                                 throws NotAuthorizedException

Returns the physical collection that servers as a container for this template group.

Parameters:

context - Current resource context

Returns:

Collection that servers as data container

Throws:

NotAuthorizedException

resolveProfile

ITemplateList resolveProfile(IResourceContext context,
                             boolean resolveSubprofiles)

Returns all templates contained in this group.

Parameters:

context - Current resource context

resolveSubprofiles - if set, all groups included in the given group will be resolved till full depth

Returns:

ITemplateList that contains all single templates included in the group

containsTemplate

boolean containsTemplate(ITemplate template)

Checks if the group contains the given template

Parameters:

template - The template, for which the check should be done

Returns:

true if the template is contained in the group, else false

Access Rights

This class can be accessed from:

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