Class: BPMFileProperties

BPMFileProperties

The BPM File Properties control displays and allows users to view, change and delete properties associated with an BPM file/document. A BPMFileProperties control provides the following configuration properties in Process Designer:

Events

On Load:
Description: This event is triggered when the control is loaded.
Example:
me.getDocumentId()
On Error:
Description: This event is triggered when there is an error within control.
Example:
alert("There has been an error with the conrol")
Context Variables error {object}
Article(s)

new BPMFileProperties()

This constructor is never used explicitly.

Extends

  • com.ibm.bpm.coach.CoachView

Methods

clears value of all properties

getDocumentId(){String}

returns Document ID of control
Returns:
Type Description
String

getDocumentProperties(){List.<Object>}

returns list of properties
Returns:
Type Description
List.<Object>

getDocumentType/getDocumentTypeId(){String}

returns document type id
Returns:
Type Description
String

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string

setDocumentId()

Sets Document ID to fetch properties for document
Type Description
String

setDocumentName()

Sets document name
Type Description
String

setDocumentType/setDocumentTypeId()

Sets document type id
Type Description
String

setPropertiesWithDefaultValues(List)

Sets passed value of property list as default value
Name Type Description
List List.<Object> of properties with default value