BPParameter Object
An instance of a parameter in a business component.

A BPParameter is based on a ComponentParam. The BPParameters are added automatically to the BPComponent when it is created from the Component. Every ComponentParam in the Component becomes a BPParameter in the BPComponent. The default value is the value of the ComponentParam from which the BPParameter is created.

The value of a BPParameter is either a constant or the value of another BPParameter. BPParameter.Type is either CONSTANT or REF_BPPARAM, respectively.

If a CONSTANT, get the value from the ComponentParam.Value of the component returned by the ComponentParam Property of the BPParameter.

If the type is REF_BPPARAM, then the value is the output value of another BPParameter. Get the source BPParameter from the Reference Property, then get the source's constant value from its ComponentParam as described above: sourceBPParameter.ComponentParam.Value.

Get a BPParameter from the list returned by BPComponent.BPParams.

Save changes to the object with BusinessProcess.Save, using the BusinessProcess object of which this is a child object.

Public Methods
Public Method LockObjectLocks the object. Returns True if the object has been changed on the server.
Public Method PostPosts all changed values into database.
Public Method RefreshReads saved values, overwriting values in memory.
Public Method UndoUndoes changes to field values that have not been posted.
Public Method UnLockObjectUnlocks the object.
Public Properties
Public Property AutoPostIf true, the database is updated immediately when the field value changes.
Public Property BPComponentThe BPComponent object to which this parameter belongs.
Public Property ComponentParamThe ComponentParam object from which this BPParam was created.
Public Property ComponentParamIsOutIndicates if this is an output parameter. 1 indicates an output parameter. Any other value indicates an input parameter.
Public Property ComponentParamNameThe name of the ComponentParam object from which this BPParam was created.
Public Property ComponentParamOrderThe position of the ComponentParam object from which this BPParam was created.
Public Property FieldThe value of the specified field.
Public Property IDThe item ID.
Public Property IsLockedChecks if object is locked for editing.
Public Property ModifiedChecks if the item has been modified since last refresh or post operation. If true, the field properties on the server side are not up to date.
Public Property ReferenceThe output BPParameter object that is the source of the value for this parameter.
Public Property TypeThe parameter type.
Public Property VirtualChecks if this is a virtual item, that is, an item that does not have a corresponding database record.
See Also