com.sapportals.portal.pcd.gl

Interface IDlModificationState

public interface IDlModificationState

Provides information on the modification status of a context that inherits through the deltalink mechanism from another context.

This interface is not intended to be implemented by clients.

Method Summary

Modifier and Type	Method and Description
boolean	attributeIsInheritedAsFinal(String attributeId) Determines if the specified attribute was inherited as final.
boolean	containsAttributeModifications() Returns true if the object is inherited and its attributes are modified through the deltalink.
Iterator	getDeletedEntries() Lists the subtree-nodes that were deleted by this deltalink, if called on a deltalink.
IPcdAttribute	getInheritedAttribute(String attributeId) Returns the attributes that were inherited from the deltalink's target object.
ModificationItem[]	getModifications(String attributeId) Provides access to the modifications by the deltalink, if any.
Iterator	getModifiedAttributeIds() Returns the ids of all attributes that were modified by the encompassing deltalink.
String[]	getModifiedAttributes() Returns the same result as getModifiedAttributeIds(), but in form of a String array.
String	getSourceUrl() Returns the Pcd Url of the node from which the node to which this instance refers inherits.
boolean	sortingIsModified() Returns true if the child sorting is modified through the embracing deltalink.

Method Detail

containsAttributeModifications

boolean containsAttributeModifications()

Returns true if the object is inherited and its attributes are modified through the deltalink.

Returns:

true if the object is inherited and its attributes are modified through the deltalink

getModifications

ModificationItem[] getModifications(String attributeId)

Provides access to the modifications by the deltalink, if any.

Parameters:

attributeId - the given attributeId

Returns:

an array of modification items that are stored in the deltalink for the node to which this instance refers; can be null if no modifications are stored for the given attributeId; if not null, the returned array contains at most two entries

getModifiedAttributeIds

Iterator getModifiedAttributeIds()

Returns the ids of all attributes that were modified by the encompassing deltalink.

Returns:

an iterator over those attribute id's for which the embracing deltalink contains attribute modifications for the node to which this instance refers. Can be empty.

getModifiedAttributes

String[] getModifiedAttributes()

Returns the same result as getModifiedAttributeIds(), but in form of a String array.

Returns:

String[]

sortingIsModified

boolean sortingIsModified()

Returns true if the child sorting is modified through the embracing deltalink.

Returns:

boolean

getSourceUrl

String getSourceUrl()

Returns the Pcd Url of the node from which the node to which this instance refers inherits.

Returns:

String

attributeIsInheritedAsFinal

boolean attributeIsInheritedAsFinal(String attributeId)

Determines if the specified attribute was inherited as final. This convenience method is provided here since the implementation avoids cloning and thus is pretty fast.

Parameters:

attributeId - the given attributeId

Returns:

true if the attribute is inherited as final; false in all other circumstances

getInheritedAttribute

IPcdAttribute getInheritedAttribute(String attributeId)

Returns the attributes that were inherited from the deltalink's target object. Retrieves a copy of the specified attribute that was inherited from the node from which the node to which this instance refers inherits. Performs internally attribute cloning.

Parameters:

attributeId - the given attributeId

Returns:

the inherited version of the specified attribute; can be null

getDeletedEntries

Iterator getDeletedEntries()

Lists the subtree-nodes that were deleted by this deltalink, if called on a deltalink.

Returns:

if called on a Deltalink, an Iterator of Strings; each String denotes the name of a deleted child/subtree; the names are relative to the deltalink; null is returned if this method is called on an object that is not a deltalink itself.