Methods

Table 81 summarizes the methods of the ContentMetaData class.

Table 81.

Member methods of the ContentMetaData class
Member method Description Page
ContentMetaData() Creates a content-meta-data object. ContentMetaData()
badContent() Returns a content-meta-data object that indicates the ODA is unable to generate the specified content type. badContent()
contentNotReady() Returns a content-meta-data object that indicates the ODA is not yet finished with the content generation. contentNotReady()
contentUnavailable() Returns a content-meta-data object that indicates the ODA is not generating the specified content, even though it implements the corresponding interface. contentUnavailable()

ContentMetaData()

Creates a content-meta-data object.

Syntax

public ContentMetaData(ContentType contentType, long length, long count);

Parameters

contentType
Is a ContentType object that indicates the content type of the generated content that the content-meta-data object describes; the value of this parameter initializes the contentType member variable of the content-meta-data object (contentType).

count
Specifies number of content elements in the requested content; the value of this parameter initializes the count member variable in the content-meta-data object (count).

length
Specifies the total size of the requested content, in bytes; the value of this parameter initializes the length member variable in the content-meta-data object (length). Business Object Wizard does not currently use the length member variable.

Return values

A newly instantiated ContentMetaData object.

badContent()

Notifies Business Object Wizard that the content that the ODA has generated is incomplete or in some other way has an error.

Syntax

public static ContentMetaData badContent(ContentType contentType);

Parameters

contentType
Is the ContentType object that identifies the content type of the bad generated content.

Return values

A ContentMetaData object that describes the unsuccessfully generated content.

contentNotReady()

Notifies Business Object Wizard that the ODA is not yet finished generating the specified content.

Syntax

public static ContentMetaData contentNotReady(ContentType contentType);

Parameters

contentType
Is the ContentType object that identifies the content type of the incomplete generated content.

Return values

A ContentMetaData object that describes the incompletely generated content.

contentUnavailable()

Notifies Business Object Wizard that the ODA does not support generation of the specified content, even though it implements the corresponding interface.

Syntax

public static ContentMetaData contentUnavailable(ContentType contentType);

Parameters

contentType
Is the ContentType object that identifies the content type of the unavailable generated content.

Return values

A ContentMetaData object that describes the unavailable generated content.

Notes

The contentUnavailable() method indicates that the ODA does not generate content of the contentType content type. For example, if an ODA supports only a callback content protocol for a particular content type, Business Object Wizard never calls its content-generation method (generateBoDefs() for business-object-definition content or generateBinFiles() for binary-file content). Therefore, the content-generation method can call contentUnavailable() as its return value to Business Object Wizard.

Copyright IBM Corp. 1997, 2003