com.sapportals.wcm.service.relation

Interface IRelationTypeAttributes

public interface IRelationTypeAttributes

The attributes of a IRelationType .
IRelationTypeAttributes define:

• the meta data for the IRelation s, that are the required properties
• constraints for the IRelation/s, like deletion of a relation if their source operand is deleted
• the IRelationTypeHandler , which defines the 'workarea' of the relation type

Method Summary

IPropertyNameList	getRequiredProperties() Get the list of required properties for the relations of this type.
IRelationTypeHandler	getTypeHandler() Get the relation type's handler.
boolean	isOneToOne() True, if only 1:1 relations are allowed (only one relation per source operand).
boolean	isOrdered() True, if the relations are ordered with respect to their source operand.
boolean	isSourceChangeTrackingEnabled() True, if the relations are updated, when object which are referenced by the source operands, are renamed.
boolean	isSourceCopyTrackingEnabled() True, if relations are to be copied, when an object referenced by a source operand, was copied.
boolean	isSourceDeleteTrackingEnabled() True, if the relations will be deleted, when their source operand is deleted.
boolean	isTargetChangeTrackingEnabled() True, if the relations are updated, when object which are referenced by the target operands, are renamed.
boolean	isTargetCopyTrackingEnabled() True, if the relations are updated, when object which are referenced by the target operands, are renamed.
boolean	isTargetDeleteTrackingEnabled() True, if the relations will be deleted, when their target operand is deleted.

Method Detail

getTypeHandler

IRelationTypeHandler getTypeHandler()

Get the relation type's handler.

Returns:

a IRelationTypeHandler which specifies the handler for the relation type.

getRequiredProperties

IPropertyNameList getRequiredProperties()

Get the list of required properties for the relations of this type.
Not yet supported!

Returns:

a IPropertyNameList with the required properties for the relations of this relation type, might be empty.

isOneToOne

boolean isOneToOne()

True, if only 1:1 relations are allowed (only one relation per source operand).

Returns:

a boolean true , if only 1:1 relations are allowed.

isOrdered

boolean isOrdered()

True, if the relations are ordered with respect to their source operand.
(not yet implemented)

Returns:

a boolean true , if relations are ordered within that type and source operand.

isSourceDeleteTrackingEnabled

boolean isSourceDeleteTrackingEnabled()

True, if the relations will be deleted, when their source operand is deleted.

Returns:

a boolean true , if relations are deleted when their source operand gets deleted.

isTargetDeleteTrackingEnabled

boolean isTargetDeleteTrackingEnabled()

True, if the relations will be deleted, when their target operand is deleted.

Returns:

a boolean true , if relations are deleted when their target operand gets deleted.

isSourceChangeTrackingEnabled

boolean isSourceChangeTrackingEnabled()

True, if the relations are updated, when object which are referenced by the source operands, are renamed.

Returns:

a boolean true , if relations are updated when the referenced source operand object gets renamed. Warning: if renaming the object referenced by the source operand violates the constraint defined by the source operand's type, the relation will be deleted if this flag is enabled.

isTargetChangeTrackingEnabled

boolean isTargetChangeTrackingEnabled()

True, if the relations are updated, when object which are referenced by the target operands, are renamed.

Returns:

a boolean true , if relations are updated when the referenced target operand object gets renamed. Warning: if renaming the object referenced by the target operand violates the constraint defined by the target operand's type, the relation will be deleted if this flag is enabled.

isSourceCopyTrackingEnabled

boolean isSourceCopyTrackingEnabled()

True, if relations are to be copied, when an object referenced by a source operand, was copied.

Returns:

a boolean true , if relations are updated when the referenced source operand object gets renamed. Warning: if renaming the object referenced by the source operand violates the constraint defined by the source operand's type, the relation will be deleted if this flag is enabled.

isTargetCopyTrackingEnabled

boolean isTargetCopyTrackingEnabled()

True, if the relations are updated, when object which are referenced by the target operands, are renamed.

Returns:

a boolean true , if relations are updated when the referenced target operand object gets renamed. Warning: if renaming the object referenced by the target operand violates the constraint defined by the target operand's type, the relation will be deleted if this flag is enabled.

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