SessionIndex (OpenAM Project 16.0.0-SNAPSHOT API)

All Known Implementing Classes:

SessionIndexImpl
```
public interface SessionIndex
```
This class represents the SessionIndex element in SAML protocol schema. The SessionIndex element specifies a session index value of a authenticated principal.
```
 <element name="SessionIndex" type="{http://www.w3.org/2001/XMLSchema}string"/>
 
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getValue()`	Returns the `SessionIndex` value.
`String`	`toXMLString()`	Returns the `SessionIndex` in an XML document String format based on the `SessionIndex` schema described above.
`String`	`toXMLString(boolean includeNSPrefix, boolean declareNS)`	Returns the `SessionIndex` in an XML document String format based on the `SessionIndex` schema described above.

- Method Detail
  - getValue
```
String getValue()
```
    Returns the SessionIndex value.
    
    Returns:
    
    A String value of the SessionIndex
  - toXMLString
```
String toXMLString()
            throws SAML2Exception
```
    Returns the SessionIndex in an XML document String format based on the SessionIndex schema described above.
    
    Returns:
    
    A XML String representing the SessionIndex.
    
    Throws:
    
    SAML2Exception - if some error occurs during conversion to String.
  - toXMLString
```
String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
            throws SAML2Exception
```
    Returns the SessionIndex in an XML document String format based on the SessionIndex schema described above.
    
    Parameters:
    
    includeNSPrefix - Determines whether or not the namespace qualifier is prepended to the Element when converted
    
    declareNS - Determines whether or not the namespace is declared within the Element.
    
    Returns:
    
    A XML String representing the SessionIndex.
    
    Throws:
    
    SAML2Exception - if some error occurs during conversion to String.