org.openspml.v2.msg.spmlsearch
Class SearchQuery

java.lang.Object
  extended byorg.openspml.v2.msg.spml.Extensible
      extended byorg.openspml.v2.msg.spmlsearch.SearchQuery
All Implemented Interfaces:
Marshallable, MarshallableElement, OpenContentContainer
Direct Known Subclasses:
Query

public abstract class SearchQuery
extends Extensible
implements Marshallable

From the specification... Open content is one or more instances of QueryClauseType (including SelectionType) or LogicalOperator.

Author:
kent.spaulding@sun.com

Date: Feb 16, 2006


Constructor Summary
protected SearchQuery()
           
protected SearchQuery(QueryClause[] queryClauses, PSOIdentifier basePsoID, java.lang.String targetID, Scope scope)
           
 
Method Summary
 void addQueryClause(QueryClause queryClause)
           
 void clearQueryClause()
           
 boolean equals(java.lang.Object o)
           
 PSOIdentifier getBasePsoID()
           
 PrefixAndNamespaceTuple[] getNamespacesInfo()
          We need to know the namespace of the class to include.
 QueryClause[] getQueryClauses()
           
 Scope getScope()
           
 java.lang.String getTargetID()
           
 int hashCode()
           
 boolean isValid()
          Is this ready to go or are there syntax errors, like missing required fields?
 boolean removeQueryClause(QueryClause queryClause)
           
 void setBasePsoID(PSOIdentifier basePsoID)
           
 void setScope(Scope scope)
           
 void setTargetID(java.lang.String targetID)
           
 java.lang.String toXML(XMLMarshaller m)
          Visitor pattern - dispatch this type to the visitor (m) please.
 
Methods inherited from class org.openspml.v2.msg.spml.Extensible
addOpenContentAttr, addOpenContentAttr, addOpenContentElement, findOpenContentAttrValueByName, findOperationalAttrByName, findOperationalNVPByName, getOpenContentAttrs, getOpenContentElements, removeOpenContentAttr, removeOpenContentElement, setOpenContent, setOpenContentAttrs, setOpenContentElements
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchQuery

protected SearchQuery()

SearchQuery

protected SearchQuery(QueryClause[] queryClauses,
                      PSOIdentifier basePsoID,
                      java.lang.String targetID,
                      Scope scope)
Method Detail

getQueryClauses

public QueryClause[] getQueryClauses()

clearQueryClause

public void clearQueryClause()

addQueryClause

public void addQueryClause(QueryClause queryClause)

removeQueryClause

public boolean removeQueryClause(QueryClause queryClause)

getBasePsoID

public PSOIdentifier getBasePsoID()

setBasePsoID

public void setBasePsoID(PSOIdentifier basePsoID)

getTargetID

public java.lang.String getTargetID()

setTargetID

public void setTargetID(java.lang.String targetID)

getScope

public Scope getScope()

setScope

public void setScope(Scope scope)

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class Extensible

hashCode

public int hashCode()
Overrides:
hashCode in class Extensible

getNamespacesInfo

public PrefixAndNamespaceTuple[] getNamespacesInfo()
Description copied from interface: MarshallableElement
We need to know the namespace of the class to include.

Specified by:
getNamespacesInfo in interface MarshallableElement
Overrides:
getNamespacesInfo in class Extensible

toXML

public java.lang.String toXML(XMLMarshaller m)
                       throws Spml2Exception
Description copied from interface: Marshallable
Visitor pattern - dispatch this type to the visitor (m) please.

Specified by:
toXML in interface Marshallable
Parameters:
m -
Returns:
xml
Throws:
Spml2Exception

isValid

public boolean isValid()
Description copied from interface: MarshallableElement
Is this ready to go or are there syntax errors, like missing required fields?

Specified by:
isValid in interface MarshallableElement
Overrides:
isValid in class Extensible


Copyright © Sun Microsystems, Inc. All Rights Reserved.