IsManifest

Type Parameters:

P - A concrete parent IsManifest object. Each IsManifest object optionally contains a list of child IsManifest objects. The container manifest is considered the parent.

C - A concrete child IsManifest object. This is the type of object expected as children in a parent (P) manifest.

All Superinterfaces:

HasFeedbackKey, HasTutoring

All Known Implementing Classes:

Manifest, TutorStrategies
```
public interface IsManifest<P extends IsManifest<P,C>,C extends IsManifest<P,C>>
extends HasTutoring, HasFeedbackKey
```
The IsManifest interface defines the API for a manifest object.
An implementing class acts as a container for a collection of ASSISTments content. Each manifest, referencing content and optionally contains children manifests, defines a structure for the content. A root manifest represents the starting point for the collection of content.
That content can be a combination of assessment and assistance material. Most typically, the assessment content comes in the form of answerable problems while assistance content comes in the form of tutoring.
Please note that an implementing class must not directly contain content, but rather contains some combination of the following:
- a reference to a Content subclass which contains the assessment content
- a reference to a Content subclass which directly contains assistance content or to another IsManifest object which further contains assistance content
- a list of child IsManifest objects
Typically:
- An IsManifest which contains children represents a collection (or set) of content. For example a Problem Set or a Hint Set.
- An IsManifest without children represents a piece of content. For example a Fill-in Problem or a Hint.
The following diagram provides an overview example of a manifest and its referenced content:

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addChildManifest(C child)` Adds a child to this `IsManifest`.
`java.lang.String`	`addProperty(java.lang.String key, boolean value)`
`java.lang.String`	`addProperty(java.lang.String key, int value)`
`java.lang.String`	`addProperty(java.lang.String key, long value)`
`java.lang.String`	`addProperty(java.lang.String key, java.lang.String value)` Adds a property to this `IsManifest`
`java.util.List<java.lang.String>`	`flatten()` Returns a list of Persistence Keys for all of objects referenced by this manifest.
`int`	`getChildCount()` Returns the number of children manifests
`java.util.List<C>`	`getChildManifests()` Returns the children of this manifest.
`java.util.List<java.lang.String>`	`getChildrenContentKeys()` Returns a list of Persistence Keys for this manifest's direct children.
`ContentTypeAttributes`	`getContentAttributes()` Returns the attribute values corresponding to this manifest's assessment content.
`java.lang.String`	`getContentKey()` Returns the Persistence Key for the assessment content referenced by this manifest.
`java.lang.String`	`getContentType()` Returns the fully specified class name of the referenced assessment content.
`java.lang.String`	`getNavigatorClass()` Returns this Manifest's navigator class name, if any.
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Returns the properties assigned to this manifest.
`java.lang.String`	`getTerminatorClass()` Returns this Manifest's terminator class name, if any.
`ContentTypeAttributes`	`getTutoringAttributes()` Returns the attribute values corresponding to this manifest's assistance content.
`java.lang.String`	`getTutoringType()` Returns the fully specified class name of the referenced assistance content.
`boolean`	`hasDescendant(C manifest)` Determines whether the specified manifest is a child of this manifest.
`boolean`	`isContentType(java.lang.String classType)` Returns whether the referenced assessment content is of the specified type.
`boolean`	`isNavigatorType(java.lang.String shortNameType)` Returns whether this `Manifest` has a specific `Navigator` type by name.
`boolean`	`isProblem()` Returns whether this manifest represents some type of problem.
`boolean`	`isProblemSet()` Returns whether this manifest represents a problem set.
`boolean`	`isSet()` Returns whether this manifest represents any type of set - either a problem set or a tutoring set.
`boolean`	`isTerminatorType(java.lang.String shortNameType)` Returns whether this `Manifest` has a specific `Terminator` type by name.
`boolean`	`isTutoringItem()` Returns whether this manifest represents some type of assistance content.
`boolean`	`isTutoringSet()` Returns whether this manifest represents an assistance set.
`boolean`	`isTutoringType(java.lang.String classType)` Returns whether the referenced assistance content is of the specified type.
`void`	`setChildManifests(java.util.List<C> childManifests)` Specifies a list of children manifests for this manifest.
`void`	`setContentKey(Persistable content)` Sets the Persistence Key for the assessment content associated with this manifest.
`void`	`setContentKey(java.lang.String contentKey)` Sets the Persistence Key for the assessment content associated with this manifest.
`void`	`setProperties(java.util.Map<java.lang.String,java.lang.String> properties)` Sets caller-defined properties to associate with this manifest.
`java.lang.String`	`toString()` Returns a string representation of this `IsManifest`.

Methods inherited from interface org.assistments.domain.content.tutor.HasTutoring
getTutoringKey, setTutoringKey, setTutoringKey

Methods inherited from interface org.assistments.domain.content.tutor.HasFeedbackKey
feedBackKeyExists, getFeedbackKey, setFeedbackKey

- Method Detail
  - getChildManifests
```
java.util.List<C> getChildManifests()
```
    Returns the children of this manifest.
    
    Returns:
    
    A list of child manifests
  - getChildCount
```
int getChildCount()
```
    Returns the number of children manifests
  - setChildManifests
```
void setChildManifests(java.util.List<C> childManifests)
```
    Specifies a list of children manifests for this manifest. setChildManifests() replaces any existing children.
    The implementing class may choose to manipulate childManifests in such a way that requires the creation of additional persistable data. For example: An IsManifest class might choose to group the children based on the type of skill represented by each referenced assessment content. In that scenario, the setChildManifests() implementation might further choose to create a new manifest for each skill and insert into that new manifest the subset of childManifests containing that skill. In this case, setChildManifests() needs to alert the caller to the presence of generated objects through the return value.
    
    Parameters:
    
    childManifests - A list of child manifests
  - addChildManifest
```
void addChildManifest(C child)
```
    Adds a child to this IsManifest.
    
    Parameters:
    
    child - Child manifest to add.
    
    See Also:
    
    setChildManifests(List)
  - hasDescendant
```
boolean hasDescendant(C manifest)
```
    Determines whether the specified manifest is a child of this manifest.
    
    Parameters:
    
    manifest - Manifest to check as a child.
    
    Returns:
    
    true if manifest is a child of this manifest; otherwise false
  - getContentKey
```
java.lang.String getContentKey()
```
    Returns the Persistence Key for the assessment content referenced by this manifest.
    
    See Also:
    
    setContentKey(String), setContentKey(Persistable), getContentType(), Persistable
  - setContentKey
```
void setContentKey(java.lang.String contentKey)
```
    Sets the Persistence Key for the assessment content associated with this manifest.
    
    Parameters:
    
    contentKey - A Persistence Key
    
    See Also:
    
    setContentKey(Persistable), getContentKey(), getContentType(), Persistable
  - setContentKey
```
void setContentKey(Persistable content)
```
    Sets the Persistence Key for the assessment content associated with this manifest.
    This is a convenience method providing an alternative to the following:
    this.setContentKey(content.getContentKey()):
    
    Parameters:
    
    content - A Persistable object
    
    See Also:
    
    setContentKey(String), getContentKey(), getContentType(), Persistable
  - getContentType
```
java.lang.String getContentType()
```
    Returns the fully specified class name of the referenced assessment content. This is a convenience method equivalent to calling:
    Persistable.extractType(this.getContentKey()):
    
    Returns:
    
    A fully specified class name.
    
    See Also:
    
    getContentKey(), isContentType(String)
  - isContentType
```
boolean isContentType(java.lang.String classType)
```
    Returns whether the referenced assessment content is of the specified type.
    
    Parameters:
    
    classType - The fully specified name of a Content subclass.
    
    Returns:
    
    true if the value returned from getContentType() is identical to classType; otherwise false.
    
    See Also:
    
    getContentType()
  - getTutoringType
```
java.lang.String getTutoringType()
```
    Returns the fully specified class name of the referenced assistance content. This is a convenience method equivalent to calling:
    Persistable.extractType(getTutoringKey()):
    
    Returns:
    
    A fully specified class name.
    
    See Also:
    
    HasTutoring.getTutoringKey(), isTutoringType(String)
  - isTutoringType
```
boolean isTutoringType(java.lang.String classType)
```
    Returns whether the referenced assistance content is of the specified type.
    
    Parameters:
    
    classType - The fully specified name of a Persistable subclass.
    
    Returns:
    
    true if the value returned from HasTutoring.getTutoringKey() is identical to classType; otherwise false.
    
    See Also:
    
    HasTutoring.getTutoringKey()
  - getContentAttributes
```
ContentTypeAttributes getContentAttributes()
```
    Returns the attribute values corresponding to this manifest's assessment content.
    
    See Also:
    
    ContentTypeAttributes, getTutoringAttributes()
  - getTutoringAttributes
```
ContentTypeAttributes getTutoringAttributes()
```
    Returns the attribute values corresponding to this manifest's assistance content.
    
    See Also:
    
    ContentTypeAttributes, getContentAttributes()
  - isProblem
```
boolean isProblem()
```
    Returns whether this manifest represents some type of problem.
    
    See Also:
    
    isProblemSet(), isContentType(String), isTutoringType(String)
  - isProblemSet
```
boolean isProblemSet()
```
    Returns whether this manifest represents a problem set.
    
    See Also:
    
    isProblem(), isContentType(String), isTutoringType(String)
  - isSet
```
boolean isSet()
```
    Returns whether this manifest represents any type of set - either a problem set or a tutoring set.
    
    See Also:
    
    isProblemSet(), isTutoringSet()
  - isTutoringItem
```
boolean isTutoringItem()
```
    Returns whether this manifest represents some type of assistance content.
    
    See Also:
    
    isTutoringSet(), isProblem(), isProblemSet(), isContentType(String), isTutoringType(String)
  - isTutoringSet
```
boolean isTutoringSet()
```
    Returns whether this manifest represents an assistance set.
    
    See Also:
    
    isTutoringItem(), isProblem(), isProblemSet(), isContentType(String), isTutoringType(String)
  - getProperties
```
java.util.Map<java.lang.String,java.lang.String> getProperties()
```
    Returns the properties assigned to this manifest.
    
    See Also:
    
    setProperties(Map)
  - setProperties
```
void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
```
    Sets caller-defined properties to associate with this manifest. Any existing properties are replaced by the new properties.
    
    Parameters:
    
    properties - A collection of user-defined (key,value) pairs.
    
    See Also:
    
    getProperties()
  - addProperty
```
java.lang.String addProperty(java.lang.String key,
                             java.lang.String value)
```
    Adds a property to this IsManifest
    
    Parameters:
    
    key - Property's key name
    
    value - Property's value
    
    Returns:
    
    If an entry already exists for key, the value being replaced. Otherwise, returns null if a value for key does not already exist.
  - addProperty
```
java.lang.String addProperty(java.lang.String key,
                             int value)
```
  - addProperty
```
java.lang.String addProperty(java.lang.String key,
                             long value)
```
  - addProperty
```
java.lang.String addProperty(java.lang.String key,
                             boolean value)
```
  - flatten
```
java.util.List<java.lang.String> flatten()
```
    Returns a list of Persistence Keys for all of objects referenced by this manifest. This includes referenced assessment objects, assistance objects, and child manifest objects.
    
    See Also:
    
    Persistable, getContentKey(), HasTutoring.getTutoringKey(), getChildManifests()
  - getChildrenContentKeys
```
java.util.List<java.lang.String> getChildrenContentKeys()
```
    Returns a list of Persistence Keys for this manifest's direct children.
    
    Returns:
    
    a list of Persistence keys.
  - getNavigatorClass
```
java.lang.String getNavigatorClass()
```
    Returns this Manifest's navigator class name, if any.
    
    Returns:
    
    The navigator class name or null, if not applicable to this Manifest.
  - getTerminatorClass
```
java.lang.String getTerminatorClass()
```
    Returns this Manifest's terminator class name, if any.
    
    Returns:
    
    The terminator class name or null, if not applicable to this Manifest.
  - isNavigatorType
```
boolean isNavigatorType(java.lang.String shortNameType)
```
    Returns whether this Manifest has a specific Navigator type by name.
    
    Parameters:
    
    shortNameType - The (not fully specified) Navigator class name. Ex: "LinearNavigator"
    
    Returns:
    
    true if this Manifest has a Navigator of the provided name; otherwise false.
  - isTerminatorType
```
boolean isTerminatorType(java.lang.String shortNameType)
```
    Returns whether this Manifest has a specific Terminator type by name.
    
    Parameters:
    
    shortNameType - The (not fully specified) Terminator class name. Ex: "CompleteNTerminator"
    
    Returns:
    
    true if this Manifest has a Terminator of the provided name; otherwise false.
  - toString
```
java.lang.String toString()
```
    Returns a string representation of this IsManifest.
    
    Overrides:
    
    toString in class java.lang.Object

Interface IsManifest<P extends IsManifest<P,C>,C extends IsManifest<P,C>>

Method Summary

Methods inherited from interface org.assistments.domain.content.tutor.HasTutoring

Methods inherited from interface org.assistments.domain.content.tutor.HasFeedbackKey

Method Detail

getChildManifests

getChildCount

setChildManifests

addChildManifest

hasDescendant

getContentKey

setContentKey

setContentKey

getContentType

isContentType

getTutoringType

isTutoringType

getContentAttributes

getTutoringAttributes

isProblem

isProblemSet

isSet

isTutoringItem

isTutoringSet

getProperties

setProperties

addProperty

addProperty

addProperty

addProperty

flatten

getChildrenContentKeys

getNavigatorClass

getTerminatorClass

isNavigatorType

isTerminatorType

toString