commonj.connector.metadata.description
Interface SchemaDefinition


public interface SchemaDefinition

The SchemaDefinition interface provides the information required for serializing the schema defining the input or output of a function.

Since:
1.0

Method Summary
 String getContent()
          The complete contents of the schema.
 URI getLocation()
          Returns the location of the schema.
 String getNamespace()
          Returns the namespace of the schema.
 boolean isEditable()
          Returns true if the returned schema is editable, otherwise returns false.
 

Method Detail

isEditable

boolean isEditable()
Returns true if the returned schema is editable, otherwise returns false.

Returns:
Boolean Returns true if the schema is editable.

getNamespace

String getNamespace()
Returns the namespace of the schema.

Returns:
The namespace of the schema.

getLocation

URI getLocation()
Returns the location of the schema. It may be a relative or absolute location. If the location is absolute then the discovery service must guarantee access the resource using this URI.

Returns:
The location of the schema.

getContent

String getContent()
The complete contents of the schema.

If the schema imports other schema then the import must be absolute or relative to the schema that includes it.

Returns:
A string containing the contents of the schema, or null when the the URI location is absolute or the schema is local and used when building a service.