COSMOS ${releaseVersion} resource-modeling Project
Internal API Specification

org.eclipse.cosmos.rm.repository.internal.application
Interface ISMLResourceInstance

All Superinterfaces:
org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDocument, org.eclipse.cosmos.rm.repository.provisional.resource.ISMLInstanceDocument, ISMLResourceBase, java.io.Serializable
All Known Implementing Classes:
SMLFileResourceInstance

public interface ISMLResourceInstance
extends org.eclipse.cosmos.rm.repository.provisional.resource.ISMLInstanceDocument, ISMLResourceBase, java.io.Serializable

Represents a resource, which can contain zero or more facets


Method Summary
 ISMLResourceInstance resolveReference()
          If this object happens to represent a reference to a resource (i.e. isReference() returns true), then this method will have it resolved to the actual resource.
 ISMLResourceFacet[] retrieveFacets()
          Retrieves and returns the set of root level facets that are included as part of this resource
 
Methods inherited from interface org.eclipse.cosmos.rm.repository.provisional.resource.ISMLInstanceDocument
retrieveDefinition, retrieveReferences
 
Methods inherited from interface org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDocument
getMetadata, retrieveDocumentFragment
 
Methods inherited from interface org.eclipse.cosmos.rm.repository.internal.application.ISMLResourceBase
isReference, retrieveDescription, retrieveDisplayName, retrieveName
 

Method Detail

resolveReference

ISMLResourceInstance resolveReference()
                                      throws org.eclipse.cosmos.rm.repository.provisional.exception.RepositoryOperationException
If this object happens to represent a reference to a resource (i.e. isReference() returns true), then this method will have it resolved to the actual resource. If isReference() happens to return false, then the return value of this method is this object.

Returns:
An object representing the resolved resource that this reference points to
Throws:
org.eclipse.cosmos.rm.repository.provisional.exception.RepositoryOperationException

retrieveFacets

ISMLResourceFacet[] retrieveFacets()
                                   throws org.eclipse.cosmos.rm.repository.provisional.exception.RepositoryOperationException
Retrieves and returns the set of root level facets that are included as part of this resource

Returns:
Root level facets of this resource
Throws:
org.eclipse.cosmos.rm.repository.provisional.exception.RepositoryOperationException

COSMOS ${releaseVersion} resource-modeling Project
Internal API Specification