BaseIDAbstract (OpenAM Server Only 7.3.1 Documentation)

All Known Subinterfaces:

BaseID
```
@SupportedAll
public interface BaseIDAbstract
```
The BaseIDAbstract is an abstract type usable only as the base of a derived type. It includes the following attributes for use by extended identifier representations: NameQualifier [optional] The security or administrative domain that qualifies the identifier. This attribute provides a means to federate identifiers from disparate user data stores without collision. SPNameQualifier [optional] Further qualifies an identifier with the name of a service provider or affiliation of providers. This attribute provides an additional means to federate identifiers on the basis of the relying party or parties.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getNameQualifier()`	Returns the name qualifier
`String`	`getSPNameQualifier()`	Returns the `SP` name qualifier
`boolean`	`isMutable()`	Returns true if the object is mutable
`void`	`makeImmutable()`	Makes the object immutable
`void`	`setNameQualifier(String nameQualifier)`	Sets the name qualifier
`void`	`setSPNameQualifier(String spNameQualifier)`	Sets the `SP` name qualifier

- Method Detail
  - getNameQualifier
```
String getNameQualifier()
```
    Returns the name qualifier
    
    Returns:
    
    the name qualifier
  - setNameQualifier
```
void setNameQualifier(String nameQualifier)
               throws SAML2Exception
```
    Sets the name qualifier
    
    Parameters:
    
    nameQualifier - the name qualifier
    
    Throws:
    
    SAML2Exception - if the object is immutable
  - getSPNameQualifier
```
String getSPNameQualifier()
```
    Returns the SP name qualifier
    
    Returns:
    
    the SP name qualifier
  - setSPNameQualifier
```
void setSPNameQualifier(String spNameQualifier)
                 throws SAML2Exception
```
    Sets the SP name qualifier
    
    Parameters:
    
    spNameQualifier - the SP name qualifier
    
    Throws:
    
    SAML2Exception - if the object is immutable
  - makeImmutable
```
void makeImmutable()
```
    Makes the object immutable
  - isMutable
```
boolean isMutable()
```
    Returns true if the object is mutable
    
    Returns:
    
    true if the object is mutable