com.sap.portal.pcm.iview
Interface IiView

All Superinterfaces:

com.sap.portal.pcm.admin.IAttributeSet

All Known Subinterfaces:

IPage

public interface IiView

extends com.sap.portal.pcm.admin.IAttributeSet

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

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, java.lang.String atomicName, RelatedItemType type) Add a direct related item to the iView.
java.util.List	getRelatedItems(RelatedItemType type) Get all related items of the object according to the requested type.
void	removeRelatedItem(IRelatedItemEntity relatedItem) Remove a direct related item from the iView.
void	setRelatedItemActive(IRelatedItemEntity relatedItem, boolean active) Set the related item active flag.

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

deleteAttribute, deleteMetaAttribute, getAttribute, getAttribute, getAttributeIds, getAttributeType, getAvailableAttributeLocales, getAvailableMetaAttributeLocales, getMetaAttribute, getMetaAttribute, getMetaAttributeIds, getMetaAttributeType, putAttribute, putAttribute, putMetaAttribute, putMetaAttribute, save, validate

Method Detail

getRelatedItems

public java.util.List getRelatedItems(RelatedItemType type)

Get all related items of the object according to the requested type. The result list contains direct and indirect items. DynamicNavigation type items are being sorted by parent names and by level.

Parameters:

type - type of items

Returns:

a list of IRelatedItemEntity

addRelatedItem

public void addRelatedItem(com.sap.portal.pcm.INewObjectDescriptor descriptor,
                           java.lang.String atomicName,
                           RelatedItemType type)
                    throws javax.naming.NamingException

Add a direct related item to the iView. Changes will be persisted immediately (no save needed).

Parameters:

descriptor - a descriptor of the item to add

atomicName - the new name (relative)

type - type of the new item

Throws:

javax.naming.NamingException - if the addition failed.

removeRelatedItem

public void removeRelatedItem(IRelatedItemEntity relatedItem)
                       throws javax.naming.NamingException

Remove a direct related item from the iView. Changes will be persisted immediately (no save needed).

Parameters:

item - item to remove

type - type of the item to remove

Throws:

javax.naming.NamingException - if the removal failed.

setRelatedItemActive

public void setRelatedItemActive(IRelatedItemEntity relatedItem,
                                 boolean active)
                          throws javax.naming.NamingException

Set the related item active flag. Refers to either direct or indirect item. Changes will be persisted immediately (no save needed).

Parameters:

item - item with updated data

Throws:

javax.naming.NamingException - if the update failed.