public final class SearchTemplateKey extends Object
SearchTemplate
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
format()
Returns a persistent identifier for this service key.
|
static SearchTemplateKey |
forModuleSearchTemplateName(String aModuleName,
String aSearchTemplateName) |
String |
getModuleName() |
String |
getName()
Returns the full name of the search template.
|
String |
getSearchTemplateName()
Returns the local name of the search template by removing the
prefix and including the '@' character.
|
int |
hashCode() |
boolean |
isBuiltInTemplate()
Returns
true if this instance identifies a built-in template. |
static SearchTemplateKey |
parse(String aString)
Returns the template key that corresponds to the specified string.
|
String |
toString() |
public static SearchTemplateKey parse(String aString)
The specified string is generally generated by the method format()
.
IllegalArgumentException
- if the specified string does not match the
regular expression ([-\\d\\pL:_.]*)@?(%?[-\\d\\pL:_. /]+)
.public static SearchTemplateKey forModuleSearchTemplateName(String aModuleName, String aSearchTemplateName)
public String getModuleName()
public String getSearchTemplateName()
public String getName()
public boolean isBuiltInTemplate()
true
if this instance identifies a built-in template.public String format()
The search template key can be re-obtained by parsing this persistent identifier using the method
parse(String)
.