com.sun.identity.liberty.ws.dst
Class DSTQuery

java.lang.Object
  |
  +--com.sun.identity.liberty.ws.dst.DSTQuery

public class DSTQuery
extends java.lang.Object

The DSTQuery class represents a DST query request.

The following schema fragment specifies the expected content within the DSTQuery object.

 <complexType name="QueryType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{urn:liberty:idpp:2003-08}ResourceIDGroup"/>
         <element name="QueryItem" maxOccurs="unbounded">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="Select" type="{urn:liberty:idpp:2003-08}SelectType"/>
                 </sequence>
                 <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
                 <attribute name="changedSince" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
                 <attribute name="itemID" type="{urn:liberty:idpp:2003-08}IDType" />
                 <attribute name="includeCommonAttributes" type="{http://www.w3.org/2001/XMLSchema}boolean" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element ref="{urn:liberty:idpp:2003-08}Extension" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="itemID" type="{urn:liberty:idpp:2003-08}IDType" />
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 


Constructor Summary
DSTQuery()
          Constructor
DSTQuery(org.w3c.dom.Element element)
          Constructor
DSTQuery(EncryptedResourceID encResourceID, java.util.List items, java.lang.String serviceNS)
          Constructor
DSTQuery(java.lang.String resourceID, java.util.List items, java.lang.String serviceNS)
          Constructor
 
Method Summary
 EncryptedResourceID getEncryptedResourceID()
          Gets encrypted resource ID.
 java.util.List getExtension()
          Gets the extension property.
 java.lang.String getId()
          Gets id attribute.
 java.lang.String getItemID()
          Gets item ID attribute
 java.lang.String getNameSpacePrefix()
          Gets the name space prefix.
 java.lang.String getNameSpaceURI()
          Gets the name space.
 java.util.List getQueryItems()
          Gets the value of the QueryItem property.
 java.lang.String getResourceID()
          Gets resource ID.
 void setEncryptedResourceID(EncryptedResourceID encResourceID)
          Sets encrypted resource ID for the DST query.
 void setId(java.lang.String id)
          Sets id attribute
 void setItemID(java.lang.String value)
          Sets item ID attribute
 void setNameSpacePrefix(java.lang.String prefix)
          Sets the name space prefix.
 void setNameSpaceURI(java.lang.String nameSpace)
          Sets the name space.
 void setQueryItem(java.util.List items)
          Sets the value of the QueryItem property.
 void setResourceID(java.lang.String resourceID)
          Sets resource ID for the DST query.
 java.lang.String toString()
          Creates a String representation of this object.
 java.lang.String toString(boolean includeNS, boolean declareNS)
          Creates a String representation of this object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DSTQuery

public DSTQuery()
Constructor

DSTQuery

public DSTQuery(java.lang.String resourceID,
                java.util.List items,
                java.lang.String serviceNS)
Constructor
Parameters:
resourceID - id for the resource to be queried.
items - List of DSTQueryItem objects.
serviceNS - service name space.

DSTQuery

public DSTQuery(EncryptedResourceID encResourceID,
                java.util.List items,
                java.lang.String serviceNS)
Constructor
Parameters:
encResourceID - id for the encrypted resource to be queried.
items - list of DSTQueryItem objects.
serviceNS - service name space.

DSTQuery

public DSTQuery(org.w3c.dom.Element element)
         throws DSTException
Constructor
Parameters:
element - DOM Element.
Throws:
DSTException -  
Method Detail

getQueryItems

public java.util.List getQueryItems()
Gets the value of the QueryItem property.
Returns:
List of DSTQueryItem objects

setQueryItem

public void setQueryItem(java.util.List items)
Sets the value of the QueryItem property.
Parameters:
items - List of DSTQueryItem objects

getId

public java.lang.String getId()
Gets id attribute.
Returns:
id attribute.

setId

public void setId(java.lang.String id)
Sets id attribute
Parameters:
id - value of id to be set

getEncryptedResourceID

public EncryptedResourceID getEncryptedResourceID()
Gets encrypted resource ID.
Returns:
Encrypted resource ID.

setEncryptedResourceID

public void setEncryptedResourceID(EncryptedResourceID encResourceID)
Sets encrypted resource ID for the DST query.
Parameters:
encResourceID - encrypted resource ID.

getResourceID

public java.lang.String getResourceID()
Gets resource ID.
Returns:
resource ID.

setResourceID

public void setResourceID(java.lang.String resourceID)
Sets resource ID for the DST query.
Parameters:
resourceID - resource ID to be set

getItemID

public java.lang.String getItemID()
Gets item ID attribute
Returns:
String

setItemID

public void setItemID(java.lang.String value)
Sets item ID attribute
Parameters:
value - item ID to be set

getExtension

public java.util.List getExtension()
Gets the extension property.
Returns:
List of any Object

getNameSpaceURI

public java.lang.String getNameSpaceURI()
Gets the name space.
Returns:
name space.

setNameSpaceURI

public void setNameSpaceURI(java.lang.String nameSpace)
Sets the name space.
Parameters:
nameSpace - Name space URI.

setNameSpacePrefix

public void setNameSpacePrefix(java.lang.String prefix)
Sets the name space prefix.
Parameters:
prefix - Name space prefix.

getNameSpacePrefix

public java.lang.String getNameSpacePrefix()
Gets the name space prefix.
Returns:
Name space prefix.

toString

public java.lang.String toString()
Creates a String representation of this object. By default name space name is prepended to the element name
Overrides:
toString in class java.lang.Object
Returns:
String A string containing the valid XML for this element

toString

public java.lang.String toString(boolean includeNS,
                                 boolean declareNS)
Creates a String representation of this object.
Parameters:
includeNS - if true prepends all elements by their name space prefix
declareNS - if true includes the name space within the generated.
Returns:
String A string containing the valid XML for this element