org.eclipse.cosmos.rm.repository.provisional.resource
Interface ISMLInstanceDocument

All Superinterfaces:

ISMLDocument

public interface ISMLInstanceDocument
extends ISMLDocument

Represents an instance SML document. An object of this type should always have getMetadata().getDocumentType() return ISMLMetadata.DOCUMENT_TYPE_INSTANCE

Method Summary

ISMLDefinitionDocument	retrieveDefinition() Retrieves and returns the definition of this instance document.
ISMLDocument[]	retrieveReferences(ISMLMetadata metadata) Retrieves and returns all references of this document based on the meta-data passed in.

Methods inherited from interface org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDocument

getMetadata, retrieveDocumentFragment

Method Detail

retrieveDefinition

ISMLDefinitionDocument retrieveDefinition()
                                          throws RepositoryOperationException

Retrieves and returns the definition of this instance document. If the definition cannot be resolved, then null will be returned.

Returns:

The definition of this instance document or null if it cannot be determined.

Throws:

RepositoryOperationException

retrieveReferences

ISMLDocument[] retrieveReferences(ISMLMetadata metadata)
                                  throws RepositoryOperationException

Retrieves and returns all references of this document based on the meta-data passed in. If the argument is null, then all references of this document are returned.

Parameters:

metadata - Meta information used to filter the result set of document references.

Returns:

The document references of this SML document

Throws:

RepositoryOperationException - In case of an error