|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
void |
add()
Adds this query to the datastore, i.e. |
void |
add(DKSearchCriteria newCrit)
Adds a new search criteria to this query |
void |
addCriteria(DKSearchCriteria newCrit)
Adds a new search criteria to this query. |
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()
Clear datastore cache |
dkQuery |
createQuery()
Creates a query object. |
DKCQExpr |
createQueryExpr()
Creates compound query expression objects, ready for execution by the datastore execute method. |
void |
del()
Deletes this query from the datastore. |
void |
del(java.lang.String name)
Remove a search criteria from this query. |
DKSearchCriteria |
getCriteria(java.lang.String critName)
Retrieves a search criteria from a given name. |
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 |
short |
getId()
Gets search template id |
java.lang.String |
getName()
Gets the name of this query |
short |
getParametricOp()
Gets the current defined operator between search criteria. |
int[] |
getSortOrders()
Gets the list of sorting orders. |
dkCollection |
listCriteria()
Gets a list of search criteria in this query |
java.lang.String[] |
listCriteriaNames()
Gets a list of search criteria names |
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[] |
listSearchableCriteriaNames()
Gets a list of searchable criteria names |
java.lang.String[] |
listUsers()
Gets a list of userids that have access to this search template |
void |
removeCriteria(java.lang.String critName)
Remove a search criteria from this query. |
void |
removeGroup(java.lang.String name)
Removes a group name from the access list of this search template |
void |
removeUser(java.lang.String name)
Removes a user name from the access list of this search template |
void |
retrieve()
Retrieves this query from the datastore. |
DKSearchCriteria |
retrieve(java.lang.String critName)
Retrieves a search criteria from a given name. |
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 |
setId(short id)
Sets search template id |
void |
setName(java.lang.String newName)
Sets the name of this query |
void |
setParametricOp(short allOp)
Sets the operator between search criteria. |
void |
setSortOrders(int[] sortOrders)
Sets the list of sorting orders for query. |
void |
update()
Updates this query in the datastore. |
void |
update(DKSearchCriteria crit)
Update this criteria |
void |
updateCriteria(DKSearchCriteria crit)
Update this criteria. |
Method Detail |
public java.lang.String getName()
public void setName(java.lang.String newName)
name
- name of this querypublic java.lang.String getDescription()
public void setDescription(java.lang.String desc)
desc
- template descriptionpublic short getId()
public void setId(short id)
search
- template idpublic java.lang.String getEntityName()
public void setEntityName(java.lang.String entityName)
entityName
- entity namepublic dkQuery createQuery() throws DKException, java.lang.Exception
public void add() throws DKException, java.lang.Exception
public void del() throws DKException, java.lang.Exception
public void update() throws DKException, java.lang.Exception
public void retrieve() throws DKException, java.lang.Exception
public void add(DKSearchCriteria newCrit) throws DKException
newCrit
- new search criteria to be added.DKException
- if error occurs in the serverpublic void update(DKSearchCriteria crit) throws DKException
crit
- new search criteria valuesDKException
- if error occurs in the serverpublic void del(java.lang.String name) throws DKException
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
critName
- search criteria name to be retrievedDKException
- if error occurs in the serverpublic dkDatastore getDatastore()
public void setDatastore(dkDatastore ds)
ds
- reference to datastorepublic void addCriteria(DKSearchCriteria newCrit) throws DKException
newCrit
- new search criteria to be added.DKException
- if error occurs in the serverpublic void updateCriteria(DKSearchCriteria crit) throws DKException
crit
- new search criteria valuesDKException
- if error occurs in the serverpublic void removeCriteria(java.lang.String critName) throws DKException
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
critName
- search criteria name to be retrievedpublic dkCollection listCriteria() throws DKException
public java.lang.String[] listCriteriaNames() throws DKException
public java.lang.String[] listSearchableCriteriaNames() throws DKException
public java.lang.String[] listDisplayNames() throws DKException
public void setParametricOp(short allOp)
allOp
- one the following values:
public short getParametricOp()
public int[] getSortOrders()
public void setSortOrders(int[] sortOrders)
sortOrders
- an array of sorting orders for this query.public void addUser(java.lang.String name, short access) throws DKException
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
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
name
- userid name to be removedpublic void removeGroup(java.lang.String name) throws DKException
name
- group name to be removedpublic java.lang.String[] listUsers() throws DKException
public java.lang.String[] listGroups() throws DKException
public DKCQExpr createQueryExpr() throws DKException
serverName
- the name of the destination server.public void clearCache() throws DKException, java.lang.Exception
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |