BaseDescriptionDocument (Surf Web Scripts 7.17 API)

All Superinterfaces:

BaseDescription

All Known Subinterfaces:

Description

All Known Implementing Classes:

AbstractBaseDescriptionDocument, DescriptionImpl, PackageDescriptionDocument, SchemaDescriptionDocument
```
public interface BaseDescriptionDocument
extends BaseDescription
```
Interface for base description document which maps to a physical XML document

Author:

drq

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.io.InputStream`	`getDescDocument()`	Gets the description xml document for this base description document
`java.lang.String`	`getDescPath()`	Gets the path of the description xml document for this base description document
`java.lang.String`	`getStorePath()`	Gets the root path of the store of this base description document

Methods inherited from interface org.springframework.extensions.webscripts.BaseDescription
getDescription, getId, getShortName

- Method Detail
  - getStorePath
```
java.lang.String getStorePath()
```
    Gets the root path of the store of this base description document
    
    Returns:
    
    root path of store
  - getDescPath
```
java.lang.String getDescPath()
```
    Gets the path of the description xml document for this base description document
    
    Returns:
    
    document location (path)
  - getDescDocument
```
java.io.InputStream getDescDocument()
                             throws java.io.IOException
```
    Gets the description xml document for this base description document
    
    Returns:
    
    source document
    
    Throws:
    
    java.io.IOException