oracle.hsgbu.hdr.message.mtk

Interface SchemaInformation

All Superinterfaces:

Serializable

All Known Implementing Classes:

SchemaInformationImpl

public interface SchemaInformation
extends Serializable

SchemaInformation object contains data associated with an Artifact. A SchemaInformation object contains the following attributes.

• Schema type (CMET or PAYLOAD or CORE_MIF)
• CMET Id or Payload Id
• XSD content
• MIF Content
• Schema Description

The SchemaInformation object supports four types of Artifacts.

• PAYLOAD
• CMET
• CORE_MIF
• INTERACTION

When an Artifact is a Payload or CMET, both XSD content and corresponding MIF content should be populated. When an Artifact is a CORE_MIF, only the MIF content should be populated. When the Artifact is an Interaction Schema, only the XSD content should be populated. The following table describes this detail.

Type	XSD Required	MIF Required
PAYLOAD	Yes	Yes
CMET	Yes	Yes
CORE_MIF	No	Yes
INTERACTION	Yes	No

An Artifact Id will be the name of SchemaInformation object. Schema name and MIF name are derived from Artifact Id.

e.g, If an Artifact Id is PRTS_MT00008HT01, then the Schema name is derived as PRTS_MT00008HT01.xsd and MIF name is derived as PRTS_MT00008HT01.mif. If an Artifact type is CORE_MIF, then the artifact name should be set 'cmetinfo.coremif' by default.

When downloading or searching schemas, the SchemaInformation object can also be used to refer a Composite Schema. In this case, the SchemaInformation's type will be INTERACTION. When the SchemaInformation type is INTERACTION, only the XSD content will be present. MIF content will not be present. When loading the SchemaInformation list into server, the following validation rules are applied:
Validation Rules:

• SchemaInformation list should not be empty.
• SchemaInformation object should not be empty.
• The schemaInformation object type should be a PAYLOAD or CMET or CORE_MIF.
• If the SchemaInformation object type is PAYLOAD or CMET, then MIF and XSD content (both) should be present.
• If SchemaInformation type is CORE_MIF, then, MIF content should be present.
• Uploading SchemaInformation objects should not be present in any of the oracle artifacts directory.
• Payload SchemaInformation object should be present in SchemaInformation object list.
• There should be only one Payload SchemaInformation object in the SchemaInformation object list.
• If the SchemaInformation object list contains CMETs, then cmetinfo.coremif should also be present.

The following code sample explains how to populate SchemaInformation object. Example:

SchemaInformation schemaInformation = new SchemaInformationImpl();
schemaInformation.setSchemaType(SchemaInformation.CMET); // setting SchemaInformation type as CMET
schemaInformation.setXsd(xsdContent); // setting XSD content of CMET in string format
schemaInformation.setMif(mifContent); // setting MIF content of CMET in string format
schemaInformation.setSchemaDescription(testDesctiption); //setting test description in string format

Field Summary

Fields

Modifier and Type	Field and Description
static String	CMET CMET - Set by the user, if the Artifact type is CMET.
static String	CORE_MIF CORE_MIF - Set by the user, if the Artifact type is PAYLOAD.
static String	PAYLOAD PAYLOAD - Set by the user, if the Artifact type is PAYLOAD.

Method Summary

Modifier and Type	Method and Description
String	getArtifactId() Returns the schema file name (artifact id, without file extension )
String	getMif() Returns the mif content
String	getSchemaDescription() Returns the schema description
String	getSchemaType() Returns the schema type (CMET or PAYLOAD or CORE_MIF)
String	getXsd() Returns the xsd content
void	setArtifactId(String fileName) Sets the schema file name (artifact id, without file extension )
void	setMif(String m_mif) Sets the mif content
void	setSchemaDescription(String description) Sets the schema description
void	setSchemaType(String type) Sets the schema type (CMET or PAYLOAD or CORE_MIF)
void	setXsd(String m_xsd) Sets the xsd content

Field Detail

CMET

static final String CMET

CMET - Set by the user, if the Artifact type is CMET.

See Also:

Constant Field Values

PAYLOAD

static final String PAYLOAD

PAYLOAD - Set by the user, if the Artifact type is PAYLOAD.

See Also:

Constant Field Values

CORE_MIF

static final String CORE_MIF

CORE_MIF - Set by the user, if the Artifact type is PAYLOAD.

See Also:

Constant Field Values

Method Detail

getMif

String getMif()

Returns the mif content

setMif

void setMif(String m_mif)

Sets the mif content

getSchemaDescription

String getSchemaDescription()

Returns the schema description

setSchemaDescription

void setSchemaDescription(String description)

Sets the schema description

getArtifactId

String getArtifactId()

Returns the schema file name (artifact id, without file extension )

setArtifactId

void setArtifactId(String fileName)

Sets the schema file name (artifact id, without file extension )

getSchemaType

String getSchemaType()

Returns the schema type (CMET or PAYLOAD or CORE_MIF)

setSchemaType

void setSchemaType(String type)

Sets the schema type (CMET or PAYLOAD or CORE_MIF)

getXsd

String getXsd()

Returns the xsd content

setXsd

void setXsd(String m_xsd)

Sets the xsd content