Query (OpenAM Project 16.0.0-SNAPSHOT API)

java.lang.Object
- com.sun.identity.saml.protocol.Query

Direct Known Subclasses:

SubjectQuery
```
public abstract class Query
extends Object
```
This is an abstract base class for SAML query. It corresponds to the <samlp:QueryAbstractType> in SAML protocol schema.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ATTRIBUTE_QUERY`	The Query is an Attribute Query.
`static int`	`AUTHENTICATION_QUERY`	The Query is an Authentication Query.
`static int`	`AUTHORIZATION_DECISION_QUERY`	The Query is an Authorization Decision Query.
`static int`	`NOT_SUPPORTED_QUERY`	The Query is unsupported.

Constructor Summary

Constructors
Modifier Constructor Description

protected Query()
default constructor.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract int`	`getQueryType()`	Returns the type of the Query such as `AuthenticationQuery` or `AuthorizationDecisionQuery`.
`abstract String`	`toString(boolean includeNS, boolean declareNS)`	Creates a String representation of the element.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NOT_SUPPORTED_QUERY
```
public static final int NOT_SUPPORTED_QUERY
```
    The Query is unsupported.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_QUERY
```
public static final int AUTHENTICATION_QUERY
```
    The Query is an Authentication Query.
    
    See Also:
    
    Constant Field Values
  - AUTHORIZATION_DECISION_QUERY
```
public static final int AUTHORIZATION_DECISION_QUERY
```
    The Query is an Authorization Decision Query.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_QUERY
```
public static final int ATTRIBUTE_QUERY
```
    The Query is an Attribute Query.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Query
```
protected Query()
```
    default constructor.
- Method Detail
  - getQueryType
```
public abstract int getQueryType()
```
    Returns the type of the Query such as AuthenticationQuery or AuthorizationDecisionQuery.
    
    Returns:
    
    the type of Query.
  - toString
```
public abstract String toString(boolean includeNS,
                                boolean declareNS)
```
    Creates a String representation of the element.
    
    Parameters:
    
    includeNS - 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 string containing the valid XML for this element