|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.suggestion.EPPSuggestionFilter
public class EPPSuggestionFilter
A Filter encapsulates all of the configurable aspects of a Suggestion request.
Constructor Summary | |
---|---|
EPPSuggestionFilter()
Constructor. |
|
EPPSuggestionFilter(org.w3c.dom.Element aElement)
Constructor. |
Method Summary | |
---|---|
void |
addAction(EPPSuggestionAction aAction)
Add an action. |
void |
addTld(EPPSuggestionTld aTld)
Add a tld. |
java.lang.Object |
clone()
clone an EPPCodecComponent . |
void |
decode(org.w3c.dom.Element aElement)
decode a DOM element tree to initialize the instance attributes. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
encode instance into a DOM element tree. |
boolean |
equals(java.lang.Object o)
|
java.util.HashMap<java.lang.String,WeightEnum> |
getActionMap()
ActionMap getter. |
java.util.ArrayList<EPPSuggestionAction> |
getActions()
Actions getter. |
WeightEnum |
getActionWeight(java.lang.String aActionName)
Action Weight getter. |
java.lang.Boolean |
getContentFilter()
Content filter getter. |
java.lang.Boolean |
getCustomFilter()
Custom filter getter. |
WeightEnum |
getForsale()
Forsale getter. |
EPPSuggestionGeo |
getGeo()
Geo getter. |
UnsignedShort |
getMaxLength()
Max length of the suggestion getter. |
UnsignedShort |
getMaxResults()
Max results getter. |
java.util.ArrayList<EPPSuggestionTld> |
getTlds()
Tlds getter. |
java.util.HashSet<java.lang.String> |
getTldSet()
Tld set getter. |
java.lang.Boolean |
getUseHyphens()
Use hyphens getter. |
java.lang.Boolean |
getUseIdns()
Use idns getter. |
java.lang.Boolean |
getUseNumbers()
Use numbers getter. |
java.lang.Boolean |
getView()
Which view is enabled. |
java.lang.String |
getViewString()
Return the string representation of the current view. |
boolean |
hasAction(java.lang.String aName)
Has action been set. |
boolean |
hasTld(java.lang.String aTld)
Has a tld been set. |
boolean |
isGeo()
Is geo set. |
boolean |
isGrid()
Is grid set. |
boolean |
isTable()
Is table set. |
void |
resetActions()
Reset actions. |
void |
resetTlds()
Reset tlds. |
void |
setContentFilter(boolean aContentFilter)
Content filter setter. |
void |
setContentFilter(java.lang.String aContentFilterAsString)
Content filter setter. |
void |
setCustomFilter(boolean aCustomfilter)
Custom filter setter. |
void |
setCustomFilter(java.lang.String aCustomfilterAsString)
Custom filter setter. |
void |
setForSale(java.lang.String aForsale)
For sale setter. |
void |
setGeo(EPPSuggestionGeo aGeo)
Geo setter. |
void |
setGridView()
Grid view setter. |
void |
setMaxLength(short aMaxLength)
Max length setter. |
void |
setMaxLength(java.lang.String aMaxLengthAsString)
Max length setter. |
void |
setMaxResults(short aMaxResults)
Max results setter. |
void |
setMaxResults(java.lang.String aMaxResultsAsString)
Max results setter. |
void |
setTableView()
Table view setter. |
void |
setUseHyphens(boolean aUseHyphens)
Use hyphens setter. |
void |
setUseHyphens(java.lang.String aUseHyphensAsString)
Use hyphens setter. |
void |
setUseIdns(boolean aUseIdns)
Use Idns setter. |
void |
setUseIdns(java.lang.String aUseIdnsAsString)
Use Idns setter. |
void |
setUseNumbers(boolean aUseNumbers)
Use numbers flag setter. |
void |
setUseNumbers(java.lang.String aUseNumbersAsString)
Use numbers flag setter. |
void |
setView(java.lang.String aViewAsString)
View setter. |
java.lang.String |
toLogString()
Return string representation for logging purpose. |
java.lang.String |
toString()
Implementation of Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EPPSuggestionFilter()
public EPPSuggestionFilter(org.w3c.dom.Element aElement) throws EPPDecodeException
aElement
- a dom element
EPPDecodeException
Method Detail |
---|
public void addAction(EPPSuggestionAction aAction) throws InvalidValueException
aAction
- an action
InvalidValueException
public void addTld(EPPSuggestionTld aTld) throws InvalidValueException
aTld
- a tld
InvalidValueException
public void setGeo(EPPSuggestionGeo aGeo) throws InvalidValueException
aGeo
- a geo.
InvalidValueException
public java.util.HashMap<java.lang.String,WeightEnum> getActionMap()
public java.util.ArrayList<EPPSuggestionAction> getActions()
public EPPSuggestionGeo getGeo()
public WeightEnum getActionWeight(java.lang.String aActionName)
aActionName
- the action we want the weight
public java.lang.Boolean getContentFilter()
public java.lang.Boolean getCustomFilter()
public WeightEnum getForsale()
public UnsignedShort getMaxLength()
public UnsignedShort getMaxResults()
public java.util.ArrayList<EPPSuggestionTld> getTlds()
public java.util.HashSet<java.lang.String> getTldSet()
public java.lang.Boolean getUseHyphens()
public java.lang.Boolean getUseNumbers()
public java.lang.Boolean getUseIdns()
public java.lang.Boolean getView()
public java.lang.String getViewString()
public boolean hasAction(java.lang.String aName)
aName
- action name
public boolean hasTld(java.lang.String aTld)
aTld
- tld
true
if it as been set; false
otherwise.public boolean isGeo()
public boolean isGrid()
public boolean isTable()
public void resetActions()
public void resetTlds()
public void setContentFilter(boolean aContentFilter)
aContentFilter
- content filter flagpublic void setContentFilter(java.lang.String aContentFilterAsString)
aContentFilterAsString
- content filter flag as stringpublic void setCustomFilter(boolean aCustomfilter)
aCustomfilter
- a custom filter flagpublic void setCustomFilter(java.lang.String aCustomfilterAsString)
aCustomfilterAsString
- a custom filter flagpublic void setForSale(java.lang.String aForsale) throws InvalidValueException
aForsale
- for sale flag
InvalidValueException
public void setGridView()
public void setMaxLength(short aMaxLength) throws InvalidValueException
aMaxLength
- max length
InvalidValueException
public void setMaxLength(java.lang.String aMaxLengthAsString) throws InvalidValueException
aMaxLengthAsString
- max length as string
InvalidValueException
public void setMaxResults(short aMaxResults) throws InvalidValueException
aMaxResults
- max results
InvalidValueException
public void setMaxResults(java.lang.String aMaxResultsAsString) throws InvalidValueException
aMaxResultsAsString
- max results as string
InvalidValueException
public void setTableView()
public void setUseHyphens(boolean aUseHyphens)
aUseHyphens
- use hyphen flagpublic void setUseHyphens(java.lang.String aUseHyphensAsString)
aUseHyphensAsString
- use hyphen flag as stringpublic void setUseNumbers(boolean aUseNumbers)
aUseNumbers
- use number flagpublic void setUseNumbers(java.lang.String aUseNumbersAsString)
aUseNumbersAsString
- use number flag as stringpublic void setUseIdns(boolean aUseIdns)
aUseIdns
- use idns flagpublic void setUseIdns(java.lang.String aUseIdnsAsString)
aUseIdnsAsString
- use idns flag as stringpublic void setView(java.lang.String aViewAsString) throws InvalidValueException
aViewAsString
- as view
InvalidValueException
public java.lang.String toLogString()
public java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPCodecComponent
EPPCodecComponent
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPCodecComponent
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPCodecComponent
aElement
argument represents the root DOM element and is
used to traverse the DOM nodes for instance attribute values. EPPCommand
is
passed into decode
of EPPCommand to be decoded and
used to set the instance attributes.
decode
in interface EPPCodecComponent
aElement
- root DOM element associated with instance
EPPDecodeException
- Error decoding the DOM element tree.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPCodecComponent
EPPCommand
is
created and is used to append the attribute nodes of
EPPCommand
.
encode
in interface EPPCodecComponent
aDocument
- DOM document used as a factory of DOM objects.
EPPEncodeException
- Error encoding the DOM element tree.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |