com.baan.ow.xmlconnector
Interface IMetadataGenerator

public interface IMetadataGenerator

This interface provides two methods.
1. getMetaData : To generate the metadata in DTD or XML Schema format.

2. getMethodList : To generate all the available methods for the specified Business Object.

3. close : To release the used XML Connector License.

Since:

classVersion 2.3

Field Summary

static java.lang.String

COPYRIGHT

Method Summary

boolean	close() This method should be called to release the License.
boolean	getMetadata(java.lang.String p_request, java.lang.StringBuffer p_requestDocument, java.lang.StringBuffer p_responseDocument, java.lang.StringBuffer p_errorDocument, java.lang.StringBuffer p_error) This method generates the metadata in either DTD or XML Schema format.
boolean	getMethodList(java.lang.String p_objectName, java.lang.StringBuffer p_responseDocument, java.lang.StringBuffer p_error) This method generates the list of all available methods.

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

Method Detail

getMetadata

public boolean getMetadata(java.lang.String p_request,
                           java.lang.StringBuffer p_requestDocument,
                           java.lang.StringBuffer p_responseDocument,
                           java.lang.StringBuffer p_errorDocument,
                           java.lang.StringBuffer p_error)

This method generates the metadata in either DTD or XML Schema format.

It checks the validity of the User License and the input Request Document. It then retrieves the Business Object Name, Format and the Method Name from the input document. If the validation is successfull it generates the metadata in DTD format or in XMLSchema format depending on the value, the "Format" Tag contains.

Parameters:

p_request - The input document, which contains the "ObjectName" , the "MethodName", and the "Format"( DTD or XMLSchema ) Tags.

p_requestDocument - Reference variable to retrieve the Request Metadata in DTD or XML Schema format.

p_responseDocument - Reference variable to retrieve the Response Metadata in DTD or XML Schema format.

p_errorDocument - Reference variable to retrieve the Error Metadata in DTD or XML Schema format.

p_error - Referance variable to retrieve the error message in case of an error during the generation of DTD or XML Schema.

Returns:

boolean

Since:

classVersion 2.3

getMethodList

public boolean getMethodList(java.lang.String p_objectName,
                             java.lang.StringBuffer p_responseDocument,
                             java.lang.StringBuffer p_error)

This method generates the list of all available methods.

It checks for the validity of the User License. It then generates an XML instance, containing all the available methods for the specified BusinessObject.

Parameters:

p_objectName - The Business Object Name.

p_responseDocument - Reference variable to retrieve the list of all the available methods, for the given BusinessObject.

p_error - Referance variable to retrieve the error message in case of an error during the generation of the list of methods.

Returns:

boolean

Since:

classVersion 2.3

close

public boolean close()

This method should be called to release the License.

The client must explicitly call this method to release the License.

Returns:

boolean

Since:

classVersion 2.3