com.sap.portal.pcm

Interface INewObjectDescriptor

All Known Subinterfaces:

INamespaceDescriptor

public interface INewObjectDescriptor

Base interface of a descriptor for creation semantic object; Implement this interface to define how to create a new object in a PCM repository. The object structure is not defined as part of this pattern, but it is part of each semantic application documentation. The management service provides factory methods for instantiating an object descriptor.

See Also:

IObjectsManager

Method Summary

void	putAttribute(String attributeName, String value) Adds an attribute to the new object.
void	putMetaAttribute(String attributeName, String metaAttributeName, String value) Adds a meta attribute to the new object.
void	putTextAttribute(String attributeName, String value) Adds a text attribute to the new object.
void	putTextMetaAttribute(String attributeName, String metaAttributeName, String value) Adds a text meta attribute to the new object.
void	setCreationMethod(CreateMethod createMethod, String targetID) Sets the new object's template target and creation method.
void	setDescription(String description) Sets the new object's description.
void	setOriginalLocale(Locale locale) Sets the new object's original locale (the locale in which it is created).
void	setTitle(String title) Sets the new object's title.
void	setTranslationInfo(String domain, String collection) Set the new object's PCD translation info.

Method Detail

setOriginalLocale

void setOriginalLocale(Locale locale)

Sets the new object's original locale (the locale in which it is created).

Parameters:

locale - the locale

setTitle

void setTitle(String title)

Sets the new object's title.

Parameters:

title - the title

setDescription

void setDescription(String description)

Sets the new object's description.

Parameters:

description - the description text

setTranslationInfo

void setTranslationInfo(String domain,
                        String collection)

Set the new object's PCD translation info.

Parameters:

domain - the translation domain

collection - the translation collection

putAttribute

void putAttribute(String attributeName,
                  String value)

Adds an attribute to the new object.

Parameters:

attributeName - the attribute name

value - the attribute value

putTextAttribute

void putTextAttribute(String attributeName,
                      String value)

Adds a text attribute to the new object. The attribute is set with the original locale.

Parameters:

attributeName - the attribute name

value - the attribute value

putMetaAttribute

void putMetaAttribute(String attributeName,
                      String metaAttributeName,
                      String value)

Adds a meta attribute to the new object.

Parameters:

attributeName - the attribute name

metaAttributeName - the meta attribute name

value - the meta attribute value

putTextMetaAttribute

void putTextMetaAttribute(String attributeName,
                          String metaAttributeName,
                          String value)

Adds a text meta attribute to the new object. The meta attribute is set with the original locale.

Parameters:

attributeName - the attribute name

metaAttributeName - the meta attribute name

value - the meta attribute value

setCreationMethod

void setCreationMethod(CreateMethod createMethod,
                       String targetID)

Sets the new object's template target and creation method.

Parameters:

createMethod - the creation method for the new object, such as copy, delta-link, or link, defined by CreateMethod

targetID - the full JNDI URL of the template from which the object is created.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] EP-RUNTIME	[sap.com] tc/ep/semantics/api	api	EP-PIN