|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKSearchTemplateFed
This class represents a query object.
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKSearchTemplateFed()
Creates a new instance of DKSearchTempleteFed object with default values. |
|
DKSearchTemplateFed(dkDatastore ds)
Creates a new instance of DKSearchTempleteFed object associated with the given datastore object. |
Method Summary | |
void |
add()
Adds this search template to the datastore, i.e. |
void |
add(DKSearchCriteria newCrit)
Adds a new search criteria to this search template, make the criteria persistent. |
void |
addCriteria(DKSearchCriteria newCrit)
Adds a new search criteria to this search template. |
void |
addGroup(java.lang.String name,
short access)
Adds a new group name who can access this search template |
void |
addUser(java.lang.String name,
short access)
Adds a new user name who can access this search template |
void |
clearCache()
Clears all current cache data |
DKCQExpr |
createQueryExpr()
Creates compound query expression objects, ready for execution by the datastore execute method. |
void |
del()
Deletes this search template from the datastore. |
void |
del(java.lang.String name)
Remove a search criteria from this search template. |
java.lang.String |
getAssocFedEntity(java.lang.String fedTextEntityName)
Gets the associated federate entity for the federate text entity. |
java.lang.String |
getAssocFedTextEntity(java.lang.String fedParmEntityName)
Gets the associated federate text entity for the federate entity. |
java.lang.String |
getAssociatedEntityName()
Gets the associated entity name associated with this query DK_FED_MAPPED_ENTITY (will support text and parametric query) |
DKSearchCriteria |
getCriteria(java.lang.String critName)
Retrieves a search criteria for a given criteria name from memory only. |
dkDatastore |
getDatastore()
Gets the reference to the owner datastore object |
java.lang.String |
getDescription()
Gets the search template description |
java.lang.String |
getEntityName()
Gets the entity name associated with this query |
java.lang.String |
getFolderName()
Gets the folder name for this search template |
short |
getId()
Gets search template id |
java.lang.String |
getName()
Gets the name of this query |
DKNVPair |
getOption(int position)
Gets an option at the given position. |
DKNVPair |
getOption(java.lang.String name)
Gets an option with a given name. |
DKNVPair[] |
getOptionList()
|
short |
getParametricOp()
Gets the current defined operator between search criteria. |
java.lang.String |
getParmWildcard()
Gets the wild card of parametric search. |
short |
getServerParticipation()
Gets the server participation option. |
int[] |
getSortOrders()
Gets the list of sorting orders. |
java.lang.String |
getTextMultiCharWildcard()
Gets the multiple characters wild card of text search. |
java.lang.String |
getTextSingleCharWildcard()
Gets the single character wild card for text search. |
java.lang.String[] |
listAllAttrDisplayNames()
Gets a list of all attribute names of parametric search in a search template |
java.lang.String[] |
listAttrDisplayNames()
Gets the list of attributes you want to display in the results. |
dkCollection |
listCriteria()
Gets a list of search criteria of this search template |
java.lang.String[] |
listCriteriaNames()
Gets a list of search criteria names including parametric, text & qbic |
java.lang.String[] |
listDisplayNames()
Gets a list of search results column names |
java.lang.String[] |
listGroups()
Gets a list of groups that have access to this search template |
java.lang.String[] |
listParmCriteriaNames()
Gets a list of parametric search criteria names |
java.lang.String[] |
listSearchableCriteriaNames()
Gets a list of searchable criteria names that is the combination of searchable parametric & text criterion |
java.lang.String[] |
listTextCriteriaNames()
Gets a list of text search criteria names |
java.lang.String[] |
listUsers()
Gets a list of userids that have access to this search template |
int |
optionCount()
Gets the number of defined options. |
void |
removeCriteria(java.lang.String critName)
Remove a search criteria from this search template. |
void |
removeGroup(java.lang.String name)
Removes a group name from the access list of this search template |
void |
removeOption(int position)
Removes the option at the given position. |
int |
removeOption(java.lang.String name)
Removes the option with the given name. |
void |
removeUser(java.lang.String name)
Removes a user name from the access list of this search template |
void |
retrieve()
Retrieves this search template from the datastore. |
DKSearchCriteria |
retrieve(java.lang.String critName)
Retrieves a search criteria from a given name. |
void |
setAssociatedEntityName(java.lang.String assocEntityName)
Sets the associated entity name associated with this query DK_FED_MAPPED_ENTITY (will support text and parametric query) This federated entity needs to be text searchable |
void |
setDatastore(dkDatastore ds)
Sets the reference to the datastore object |
void |
setDescription(java.lang.String desc)
Sets the description for this search template |
void |
setEntityName(java.lang.String entityName)
Sets the entity name associated with this query |
void |
setFolderName(java.lang.String folderName)
Sets the folder name for this search template |
void |
setId(short id)
Sets search template id |
void |
setName(java.lang.String newName)
Sets the name of this query |
void |
setOption(int position,
DKNVPair optionPair)
Sets the option at the given position. |
int |
setOption(java.lang.String name,
java.lang.Object value)
Sets the option with the given name. |
void |
setOptionList(DKNVPair[] optionList)
|
void |
setParametricOp(short allOp)
Sets the operator between search criteria. |
void |
setParmWildcard(java.lang.String wildcard)
Sets the wild card for parametric search. |
void |
setServerParticipation(short serverP)
Sets the server participation option. |
void |
setSortOrders(int[] sortOrders)
Sets the list of sorting orders for query. |
void |
setTextMultiCharWildcard(java.lang.String wildcard)
Sets the multiple characters wild card for text search. |
void |
setTextSingleCharWildcard(java.lang.String wildcard)
Sets the single character wild card for text search. |
void |
update()
Updates this search template in the datastore. |
void |
update(DKSearchCriteria crit)
Update the specifed criteria of this search template, make the criteria persistent. |
void |
updateCriteria(DKSearchCriteria crit)
Update this criteria. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.mm.sdk.common.dkSearchTemplate |
createQuery |
Constructor Detail |
public DKSearchTemplateFed()
public DKSearchTemplateFed(dkDatastore ds) throws DKException, java.lang.Exception
Method Detail |
public java.lang.String getName()
getName
in interface dkSearchTemplate
public void setName(java.lang.String newName)
setName
in interface dkSearchTemplate
name
- name of this querypublic java.lang.String getDescription()
getDescription
in interface dkSearchTemplate
public void setDescription(java.lang.String desc)
setDescription
in interface dkSearchTemplate
desc
- template descriptionpublic java.lang.String getFolderName()
public void setFolderName(java.lang.String folderName)
folderName
- folder namepublic short getServerParticipation()
public void setServerParticipation(short serverP)
The valid options are:
Search will not skip servers, if any server is not available it will throw exception
Search will skip the servers that is not available during search of the template
Search will throw exception when any one server is not available, beans will prompt
serverP
- the server participation option.public void setTextSingleCharWildcard(java.lang.String wildcard)
wildcard
- the single character wild card in text searchpublic java.lang.String getTextSingleCharWildcard()
public void setTextMultiCharWildcard(java.lang.String wildcard)
wildcard
- the multiple characters wild card in text searchpublic java.lang.String getTextMultiCharWildcard()
public void setParmWildcard(java.lang.String wildcard)
wildcard
- the parametric search wild cardpublic java.lang.String getParmWildcard()
public short getId()
getId
in interface dkSearchTemplate
public void setId(short id)
setId
in interface dkSearchTemplate
id
- search template idpublic java.lang.String getEntityName()
getEntityName
in interface dkSearchTemplate
public void setEntityName(java.lang.String entityName)
setEntityName
in interface dkSearchTemplate
entityName
- entity namepublic java.lang.String getAssociatedEntityName()
public void setAssociatedEntityName(java.lang.String assocEntityName)
assocEntityName
- associated entity namepublic void add() throws DKException, java.lang.Exception
add
in interface dkSearchTemplate
public void del() throws DKException, java.lang.Exception
del
in interface dkSearchTemplate
public void update() throws DKException, java.lang.Exception
update
in interface dkSearchTemplate
public void retrieve() throws DKException, java.lang.Exception
retrieve
in interface dkSearchTemplate
public void add(DKSearchCriteria newCrit) throws DKException
add
in interface dkSearchTemplate
newCrit
- new search criteria to be added.DKException
- if error occurs in the serverpublic void update(DKSearchCriteria crit) throws DKException
update
in interface dkSearchTemplate
crit
- new search criteria valuesDKException
- if error occurs in the serverpublic void del(java.lang.String name) throws DKException
del
in interface dkSearchTemplate
name
- name of search criteria to be removed from memory copy.DKException
- when error occurs when removing this search criterionpublic DKSearchCriteria retrieve(java.lang.String critName) throws DKException
retrieve
in interface dkSearchTemplate
critName
- a search criteria name to be retrievedDKException,
- Exception if error occurspublic dkDatastore getDatastore()
getDatastore
in interface dkSearchTemplate
public void setDatastore(dkDatastore ds)
setDatastore
in interface dkSearchTemplate
ds
- reference to datastorepublic void addCriteria(DKSearchCriteria newCrit) throws DKException
addCriteria
in interface dkSearchTemplate
newCrit
- new search criteria to be added.DKException
- if error occurs in the serverpublic void updateCriteria(DKSearchCriteria crit) throws DKException
updateCriteria
in interface dkSearchTemplate
crit
- new search criteria valuesDKException
- if error occurs in the serverpublic void removeCriteria(java.lang.String critName) throws DKException
removeCriteria
in interface dkSearchTemplate
critName
- name of search criteria to be removed from memory copy.DKException
- when error occurs when removing this search criterionpublic DKSearchCriteria getCriteria(java.lang.String critName) throws DKException
getCriteria
in interface dkSearchTemplate
critName
- a search criteria namepublic dkCollection listCriteria() throws DKException
listCriteria
in interface dkSearchTemplate
public java.lang.String[] listCriteriaNames() throws DKException
listCriteriaNames
in interface dkSearchTemplate
public java.lang.String[] listTextCriteriaNames() throws DKException, java.lang.Exception
public java.lang.String[] listParmCriteriaNames() throws DKException, java.lang.Exception
public java.lang.String[] listDisplayNames() throws DKException
listDisplayNames
in interface dkSearchTemplate
public java.lang.String[] listSearchableCriteriaNames() throws DKException
listSearchableCriteriaNames
in interface dkSearchTemplate
public void setParametricOp(short allOp)
setParametricOp
in interface dkSearchTemplate
allOp
- one the following values:
public short getParametricOp()
getParametricOp
in interface dkSearchTemplate
public int[] getSortOrders()
getSortOrders
in interface dkSearchTemplate
public void setSortOrders(int[] sortOrders)
setSortOrders
in interface dkSearchTemplate
sortOrders
- an array of sorting orders for this query.public void addUser(java.lang.String name, short access) throws DKException
addUser
in interface dkSearchTemplate
name
- user name which already defined in this
federated server.access
- whether it is read only, updatable, or full accesspublic void addGroup(java.lang.String name, short access) throws DKException
addGroup
in interface dkSearchTemplate
name
- group name which already defined in this
federated server.access
- whether it is read only, updatable, or full accesspublic void removeUser(java.lang.String name) throws DKException
removeUser
in interface dkSearchTemplate
name
- userid name to be removedpublic void removeGroup(java.lang.String name) throws DKException
removeGroup
in interface dkSearchTemplate
name
- group name to be removedpublic java.lang.String[] listUsers() throws DKException
listUsers
in interface dkSearchTemplate
public java.lang.String[] listGroups() throws DKException
listGroups
in interface dkSearchTemplate
public DKCQExpr createQueryExpr() throws DKException
createQueryExpr
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
serverName
- the name of the destination server.public java.lang.String[] listAllAttrDisplayNames() throws DKException
public java.lang.String[] listAttrDisplayNames() throws DKException
public int optionCount()
public DKNVPair[] getOptionList()
public void setOptionList(DKNVPair[] optionList)
public DKNVPair getOption(int position)
java.lang.IndexOutOfBoundsException
- if position is invalid.public DKNVPair getOption(java.lang.String name)
public void setOption(int position, DKNVPair optionPair)
optionPair
- the new optionjava.lang.IndexOutOfBoundsException
- if position is invalid.public int setOption(java.lang.String name, java.lang.Object value)
public void removeOption(int position)
the
- position.java.lang.IndexOutOfBoundsException
- if position is invalid.public int removeOption(java.lang.String name)
name
- the option name.public java.lang.String getAssocFedEntity(java.lang.String fedTextEntityName) throws DKException, java.lang.Exception
fedTextEntityName
- the federate text entityDKException,
- Exception if error occurspublic java.lang.String getAssocFedTextEntity(java.lang.String fedParmEntityName) throws DKException, java.lang.Exception
fedParmEntityName
- the federate entityDKException,
- Exception if error occurspublic void clearCache() throws DKException, java.lang.Exception
clearCache
in interface dkSearchTemplate
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |