com.sap.portal.pcm.iview

Interface IiView

All Superinterfaces:

IAttributes, IAttributeSet, IMutableAttributes

All Known Subinterfaces:

IApplicationPage, IPage

public interface IiView
extends IAttributeSet

The interface that represents an iView semantic object. IiView contains methods for managing an iView and its related items.

See Also:

IRelatedItemEntity, IPages

Field Summary

Fields inherited from interface com.sap.portal.pcm.IAttributes

ADMINISTRATION, ATTRIBUTE_NOT_FOUND, DIALOG, DIALOG_READ_ONLY, NONDIALOG, NONE, PERSONALIZATION, STRING_ATTRIBUTE, TEXT_ATTRIBUTE

Method Summary

void	addRelatedItem(com.sap.portal.pcm.INewObjectDescriptor descriptor, String atomicName, RelatedItemType type) Creates a related item for this iView.
String	getApplicationContextURL() Returns the PCD address to atomic element that can be displayed with this iview, i.e. if this iview belong to application page it will be return the PCD address of the page, otherwise this method will return the current PCD address.
IAttributeSet	getModifications() Return the pcd layer as IAttributeSet
List	getRelatedItems(RelatedItemType type) Gets all related items of the specified type for this iView.
void	removeRelatedItem(IRelatedItemEntity relatedItem) Removes a related item for this iView.
void	setRelatedItemActive(IRelatedItemEntity relatedItem, boolean active) Sets whether the related item is visible or hidden.

Methods inherited from interface com.sap.portal.pcm.admin.IAttributeSet

save, validate

Methods inherited from interface com.sap.portal.pcm.IMutableAttributes

deleteAttribute, deleteMetaAttribute, putAttribute, putAttribute, putMetaAttribute, putMetaAttribute

Methods inherited from interface com.sap.portal.pcm.IAttributes

getAttribute, getAttribute, getAttributeIds, getAttributeType, getAvailableAttributeLocales, getAvailableMetaAttributeLocales, getMetaAttribute, getMetaAttribute, getMetaAttributeIds, getMetaAttributeType

Method Detail

getRelatedItems

List getRelatedItems(RelatedItemType type)

Gets all related items of the specified type for this iView.
The list contains both direct and indirect items.
Dynamic navigation type items are sorted by their parent names and by their level. The level is the position of the related item relative to the object in which it is displayed. Other types are not sorted.

Parameters:

type - the type of the related item

Returns:

a list of related items

addRelatedItem

void addRelatedItem(com.sap.portal.pcm.INewObjectDescriptor descriptor,
                    String atomicName,
                    RelatedItemType type)
                    throws NamingException

Creates a related item for this iView.
Create a descriptor for a related item the same as you would create one for an iView.
Changes are persisted immediately. No save is required.

Parameters:

descriptor - a descriptor for the related item

atomicName - the name of the new related item

type - the type of the new related item

Throws:

NamingException - if the operation fails

removeRelatedItem

void removeRelatedItem(IRelatedItemEntity relatedItem)
                       throws NamingException

Removes a related item for this iView. Only direct items can be removed.
Changes are persisted immediately. No save is required.

Parameters:

relatedItem - related item to remove

Throws:

NamingException - if the operation fails

setRelatedItemActive

void setRelatedItemActive(IRelatedItemEntity relatedItem,
                          boolean active)
                          throws NamingException

Sets whether the related item is visible or hidden. Use this method for either direct or indirect items.
Changes are persisted immediately. No save is required.

Parameters:

relatedItem - related item to be updated

active - true sets the related item as visible, false sets it as hidden

Throws:

NamingException - if the operation fails

getModifications

IAttributeSet getModifications()

Return the pcd layer as IAttributeSet

Returns:

IAttributeSet

getApplicationContextURL

String getApplicationContextURL()
                                throws NamingException

Returns the PCD address to atomic element that can be displayed with this iview, i.e. if this iview belong to application page it will be return the PCD address of the page, otherwise this method will return the current PCD address.

Returns:

String

Throws:

NamingException

Access Rights

This class can be accessed from:

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