getBoDefs()

Retrieves the generated business object definitions.

Syntax

public BusObjDef[] getBoDefs(long index);

Parameters

index
Specifies the business object definition to retrieve from the generated-content structure.

Exceptions

ODKException
Thrown if Business Object Wizard encounters a problem getting the generated business object definitions from the generated-content structure.

Notes

The getBoDefs() method is the content-retrieval method for the IGeneratesBoDefs interface. It retrieves generated business object definitions from the ODA's generated-content structure, which is the structure that the generateBoDefs() method populated with the generated business object definitions. The value of the index argument determines whether to getBoDefs() returns one or all generated business object definitions, as Table 94 shows.

Table 94. Specifying the business object definitions to return

Value of index argument Action of getBoDefs()

In the range: 0 to count
(where count is the member variable in the content-metadata object that specifies the number of business object definitions in the generated-content structure)

Return an array that contains one business-object-definition (BusObjDef) object, the BusObjDef object at the specified index position in the generated-content structure.


ODKConstant.GET_ALL_OBJECTS
Return an array of all generated business object definitions in the generated-content structure.

For more information on how to implement getBoDefs(), see Providing access to generated business object definitions.

See also

generateBoDefs(), getBinFile()

Copyright IBM Corp. 1997, 2004