de.smartics.properties.api.core.domain
Interface DocumentMetaData

All Superinterfaces:

Serializable

All Known Implementing Classes:

ProjectdocMetaData, PropertyProjectdoc, PropertySetProjectdoc

public interface DocumentMetaData
     
     

      
      extends 
      
      Serializable
     
     

Provides read access to document meta data.

Method Summary

List<String>	getAudience() Returns the audience the documentation targets.
List<String>	getCategories() Returns the categories associated with the document instance.
String	getName() Returns the unique document identifier.
List<String>	getNotes() Returns the list of notes appended to the document instance.
List<String>	getParents() Returns the parents associated with the document instance.
String	getShortDescription() Returns the short description of the document to be incorporated in an overview table.
String	getSortKey() Returns the value for sortKey.
String	getSpace() Returns the space within which the title of a document is required to be unique.
String	getSummary() Returns the short summary of contents of the document to give more detailed information to a potential reader.
List<String>	getTags() Returns the tags associated with the document instance.
String	getTitle() Returns the title of a document, unique within the given space.

Method Detail

getCategories

List<String> getCategories()

Returns the categories associated with the document instance.

Returns:

the categories associated with the document instance.

getTags

List<String> getTags()

Returns the tags associated with the document instance.

Returns:

the tags associated with the document instance.

getParents

List<String> getParents()

Returns the parents associated with the document instance.

Returns:

the parents associated with the document instance.

getName

String getName()

Returns the unique document identifier. It is generated by the system if not given explicitly.

Dependent on the evaluation context the name given here may be expanded to be unique. So the uniqueness of this key is dependent of the context.

Returns:

the unique document identifier.

getShortDescription

String getShortDescription()

Returns the short description of the document to be incorporated in an overview table. Should not exceed one to three sentences.

Returns:

the short description of the document to be incorporated in an overview table.

getNotes

List<String> getNotes()

Returns the list of notes appended to the document instance.

Returns:

the list of notes appended to the document instance.

getSpace

String getSpace()

Returns the space within which the title of a document is required to be unique.

Returns:

the space within which the title of a document is required to be unique.

getTitle

String getTitle()

Returns the title of a document, unique within the given space.

Returns:

the title of a document, unique within the given space.

getSummary

String getSummary()

Returns the short summary of contents of the document to give more detailed information to a potential reader. Should not exceed one too three paragraphs.

Returns:

the short summary of contents of the document to give more detailed information to a potential reader.

getSortKey

String getSortKey()

Returns the value for sortKey.

Option to sort elements. This sort key is used first for sorting the document instances in the index document of this doctype.

Returns:

the value for sortKey.

getAudience

List<String> getAudience()

Returns the audience the documentation targets.

Returns:

the audience the documentation targets.