IDSSReconciliationConstraint Interface Reference

List of all members.

---

Detailed Description

We record a single piece of information about a placeholder.

For example we might record that a report placeholder evaluates a particular form of a particular attribute.

We call it a constraint because we might wish to enforce it, meaining that we will not let a reconciliation action proceed if doing so would violate the constraint. (I.e. if the report, attribute and form are all replaced, they must be done so in a way to keep the relationship). However some constaints are for information purposes. For example we may report the name used by an attribute for a form - this isn't a constaint because we would not require a replacement attribute/form to use the same name.

Public Member Functions
HRESULT	ConstraintType ([out, retval] EnumDSSReconcileConstraintType *opType)
	This read-only property indicates the type of the constraint.
HRESULT	SecondaryReference ([out, retval] IDSSExtendedReference oppReference)
	We record reference information for secondary object to which the constraint applies.
HRESULT	TargetReference ([out, retval] IDSSExtendedReference oppReference)
	We record reference information for object to which the constraint applies.
HRESULT	TertiaryReference ([out, retval] IDSSExtendedReference oppReference)
	We record reference information for tertiary object to which the constraint applies.
HRESULT	Values ([out, retval] IDSSExtendedData oppData)
	We record simple properties for the constaint.

---

Member Function Documentation

HRESULT IDSSReconciliationConstraint::ConstraintType (  [out, retval] EnumDSSReconcileConstraintType *  opType  )

This read-only property indicates the type of the constraint. Which of the other constaint properties are used depends on the value of this property.

HRESULT IDSSReconciliationConstraint::SecondaryReference (  [out, retval] IDSSExtendedReference   oppReference  )

We record reference information for secondary object to which the constraint applies. Some constaints describe the relationship between this placeholder and two objects. For example we can record that a report placeholder depends on a particular form of an attribute. This property would be used to identify the attribute. Parameters: oppReference  Return reference information about the secondary object. May be NULL if this particular constaint type doesn't apply to two objects.

HRESULT IDSSReconciliationConstraint::TargetReference (  [out, retval] IDSSExtendedReference   oppReference  )

We record reference information for object to which the constraint applies. Some constaints describe the relationship between this placeholder and another object. For example they may record that the placeholder is embedded in the other object. For these constraints this property returns information about the other object. Parameters: oppReference  Return reference information about the other object. May be NULL if this particular constaint type doesn't apply to another object.

HRESULT IDSSReconciliationConstraint::TertiaryReference (  [out, retval] IDSSExtendedReference   oppReference  )

We record reference information for tertiary object to which the constraint applies. Some constaints describe the relationship between this placeholder and three objects. For example we can record that a document placeholder depends on a particular form of a particular attribute that is used on a report. This property would be used to identify the report. Parameters: oppReference  Return reference information about the tertiary object. May be NULL if this particular constaint type doesn't apply to three objects.

HRESULT IDSSReconciliationConstraint::Values (  [out, retval] IDSSExtendedData   oppData  )

We record simple properties for the constaint. This method returns a read-only collection of key value pairs. The supported keys depend on the constraint type. Parameters: oppData  Return properties for this constaint. May be NULL if this particular constaint type doesn't need any extra properties.

---