com.sun.identity.liberty.ws.dst

Class DSTQueryItem

java.lang.Object

com.sun.identity.liberty.ws.dst.DSTQueryItem

public class DSTQueryItem
extends Object

The class DSTQueryItem is the wrapper for one query item for Data service. The following schema fragment specifies the expected content within the DSTQueryItem object.

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

Constructor Summary

Constructors

Constructor and Description
DSTQueryItem(Element element) Constructor
DSTQueryItem(String select, boolean includeCommonAttribute, Date changedSince, String serviceNS) Constructor
DSTQueryItem(String select, String serviceNS) Constructor

Method Summary

Modifier and Type	Method and Description
Date	getChangedSince() Gets changed since attribute
String	getId() Gets id attribute.
String	getItemID() Gets itemID attribute
String	getNameSpacePrefix() Gets the name space prefix.
String	getNameSpaceURI() Gets the name space.
String	getSelect() Returns data selection string
boolean	isIncludeCommonAttributes() Checks include common attribute for the DST query item.
void	setId(String id) Sets id attribute
void	setItemID(String itemID) Sets itemID attribute
void	setNameSpacePrefix(String prefix) Sets the name space prefix.
void	setNameSpaceURI(String nameSpace) Sets the name space.
String	toString() Creates a String representation of this object.
String	toString(boolean includeNS, boolean declareNS) Creates a String representation of this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DSTQueryItem

public DSTQueryItem(String select,
                    String serviceNS)

Constructor

Parameters:

select - specifies the data the query should return

serviceNS - service Name space

DSTQueryItem

public DSTQueryItem(String select,
                    boolean includeCommonAttribute,
                    Date changedSince,
                    String serviceNS)

Constructor

Parameters:

select - specifies the data the query should return

includeCommonAttribute - if true, query response will contains common attributes (attribute id and modification time)

changedSince - Only match entries changed after the specified date

serviceNS - service Name space

DSTQueryItem

public DSTQueryItem(Element element)
             throws DSTException

Constructor

Parameters:

element - DOM Element

Throws:

DSTException - If there was an error while parsing the XML.

Method Detail

getSelect

public String getSelect()

Returns data selection string

Returns:

String

getItemID

public String getItemID()

Gets itemID attribute

Returns:

String

setItemID

public void setItemID(String itemID)

Sets itemID attribute

Parameters:

itemID - item ID to be set

getId

public String getId()

Gets id attribute.

Returns:

id attribute.

setId

public void setId(String id)

Sets id attribute

Parameters:

id - id attribute to be set

isIncludeCommonAttributes

public boolean isIncludeCommonAttributes()

Checks include common attribute for the DST query item.

Returns:

boolean

getChangedSince

public Date getChangedSince()

Gets changed since attribute

Returns:

Date

getNameSpaceURI

public String getNameSpaceURI()

Gets the name space.

Returns:

Name space.

setNameSpaceURI

public void setNameSpaceURI(String nameSpace)

Sets the name space.

Parameters:

nameSpace - Name space URI.

setNameSpacePrefix

public void setNameSpacePrefix(String prefix)

Sets the name space prefix.

Parameters:

prefix - Name space prefix.

getNameSpacePrefix

public String getNameSpacePrefix()

Gets the name space prefix.

Returns:

String Name space prefix.

toString

public String toString()

Creates a String representation of this object. By default name space name is prepended to the element name

Overrides:

toString in class Object

Returns:

String A string containing the valid XML for this element

toString

public 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