|
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.dkAbstractEntityDef | +--com.ibm.mm.sdk.common.DKFolderOD
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantOD |
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.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKFolderOD(java.lang.String name,
java.lang.String desc)
|
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 |
dkAttrDef |
createAttr()
Creates new dkAttrDef and returns it to caller. |
dkQuery |
createQuery()
Creates a query object. |
DKCQExpr |
createQueryExpr()
Creates compound query expression objects, ready for execution by the datastore execute method. |
java.lang.String |
critName(short fldId)
Gets the search criteria name from persistent datastore |
void |
del()
Deletes this query from the datastore. |
void |
del(java.lang.String name)
Remove a search criteria from this query. |
dkAttrDef |
getAttr(java.lang.String attrName)
Retrieves an attribute object from a given attribute name |
DKSearchCriteria |
getCriteria(int critNum)
|
DKSearchCriteria |
getCriteria(java.lang.String critName)
Retrieves a search criteria from a given name. |
DKSearchCriteria[] |
getCritInfo()
Gets the list of OD folder search criteria from persistent datastore Gets the list of search criteria order arrary from persistent datastore Gets the list of criteria display order arrary from persistent datastore Gets the list of criteria sort order arrary from persistent datastore |
java.lang.String |
getDescription()
Gets the search template description |
int[] |
getDisplayOrder()
Gets the display order array from persistent datastore |
java.lang.String |
getEntityName()
Gets the entity name associated with this query |
com.ibm.mm.sdk.internal.PFieldStructOD[] |
getFieldInfo()
Gets the OD folder field information from persistent datastore |
long |
getFolderId()
|
short |
getId()
Gets search template id |
java.lang.String |
getName()
Gets the name of this query |
short |
getNumCrit()
Gets the number of search criteria from persistent datastore |
short |
getNumDisplayCrit()
Gets the number of display criteria from persistent datastore |
int |
getNumFields()
|
short |
getNumQueryCrit()
Gets the number of queryable search criteria from persistent datastore |
short |
getNumSortCrit()
Gets the number of sort criteria from persistent datastore |
short |
getParametricOp()
Gets the parametric operator from persistent datastore |
DKSearchCriteria |
getQueryCriteria(int queryCritNum)
|
int[] |
getQueryOrder()
Gets the query order array from persistent datastore |
int[] |
getSortOrders()
Gets the sort order array from persistent datastore |
java.lang.String[] |
listAttrNames()
Gets a list of attributes |
dkCollection |
listAttrs()
Gets a list of attributes |
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 |
java.lang.String |
name()
|
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 |
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 |
setFolderId(long id)
|
void |
setId(short id)
Sets search template id |
void |
setName(java.lang.String newName)
Sets the name of this query |
void |
setParametricOp(short critOp)
Sets the parametric operator to persistent datastore |
void |
setSortOrders(int[] sortOrders)
Sets the sort order array to persistent datastore |
void |
update()
Updates this query in the datastore. |
void |
update(DKSearchCriteria crit)
Update this criteria |
void |
updateCriteria(DKSearchCriteria crit)
Update this criteria. |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef |
add, add, addAttr, addSubEntity, createSubEntity, datastoreName, datastoreType, del, del, deleteAttr, deleteSubEntity, getDatastore, getParentEntityName, getSubEntity, getType, hasSubEntities, isSearchable, isTextSearchable, listSubEntities, listSubEntityNames, removeAttr, removeSubEntity, retrieveAttr, retrieveSubEntity, setDatastore, setParentEntityName, setTextSearchable, setType |
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 |
getDatastore, setDatastore |
Constructor Detail |
public DKFolderOD(java.lang.String name, java.lang.String desc)
Method Detail |
public java.lang.String name()
public java.lang.String getName()
dkSearchTemplate
getName
in interface dkSearchTemplate
getName
in class dkAbstractEntityDef
com.ibm.mm.sdk.common.dkSearchTemplate
public void setName(java.lang.String newName)
dkSearchTemplate
setName
in interface dkSearchTemplate
setName
in class dkAbstractEntityDef
com.ibm.mm.sdk.common.dkSearchTemplate
name
- name of this querypublic java.lang.String getDescription()
dkSearchTemplate
getDescription
in interface dkSearchTemplate
getDescription
in class dkAbstractEntityDef
com.ibm.mm.sdk.common.dkSearchTemplate
public void setDescription(java.lang.String desc)
dkSearchTemplate
setDescription
in interface dkSearchTemplate
setDescription
in class dkAbstractEntityDef
com.ibm.mm.sdk.common.dkSearchTemplate
desc
- template descriptionpublic short getId()
dkSearchTemplate
getId
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
public void setId(short id)
dkSearchTemplate
setId
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
search
- template idpublic long getFolderId()
public void setFolderId(long id)
public java.lang.String getEntityName()
dkSearchTemplate
getEntityName
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
public void setEntityName(java.lang.String entityName)
dkSearchTemplate
setEntityName
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
entityName
- entity namepublic dkQuery createQuery() throws DKException, java.lang.Exception
dkSearchTemplate
createQuery
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
public void add() throws DKException
dkSearchTemplate
add
in interface dkSearchTemplate
add
in class dkAbstractEntityDef
com.ibm.mm.sdk.common.dkAbstractEntityDef
DKException
- when the subclass does not
implement this methodpublic void del() throws DKException
dkSearchTemplate
del
in interface dkSearchTemplate
del
in class dkAbstractEntityDef
com.ibm.mm.sdk.common.dkAbstractEntityDef
DKException
- when the subclass does not implement this methodpublic void update() throws DKException
dkSearchTemplate
update
in interface dkSearchTemplate
public void retrieve() throws DKException
dkSearchTemplate
retrieve
in interface dkSearchTemplate
public void add(DKSearchCriteria newCrit) throws DKException
dkSearchTemplate
add
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
newCrit
- new search criteria to be added.DKException
- if error occurs in the serverpublic void update(DKSearchCriteria crit) throws DKException
dkSearchTemplate
update
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
crit
- new search criteria valuesDKException
- if error occurs in the serverpublic void del(java.lang.String name) throws DKException
dkSearchTemplate
del
in interface dkSearchTemplate
com.ibm.mm.sdk.common.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
dkSearchTemplate
retrieve
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
critName
- search criteria name to be retrievedDKException
- if error occurs in the serverpublic void addCriteria(DKSearchCriteria newCrit) throws DKException
dkSearchTemplate
addCriteria
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
newCrit
- new search criteria to be added.DKException
- if error occurs in the serverpublic void updateCriteria(DKSearchCriteria crit) throws DKException
dkSearchTemplate
updateCriteria
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
crit
- new search criteria valuesDKException
- if error occurs in the serverpublic void removeCriteria(java.lang.String critName) throws DKException
dkSearchTemplate
removeCriteria
in interface dkSearchTemplate
com.ibm.mm.sdk.common.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
dkSearchTemplate
getCriteria
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
critName
- search criteria name to be retrievedpublic DKSearchCriteria getCriteria(int critNum) throws DKException
public DKSearchCriteria getQueryCriteria(int queryCritNum) throws DKException
public dkCollection listCriteria() throws DKException
dkSearchTemplate
listCriteria
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
public java.lang.String[] listCriteriaNames() throws DKException
dkSearchTemplate
listCriteriaNames
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
public java.lang.String[] listSearchableCriteriaNames() throws DKException
dkSearchTemplate
listSearchableCriteriaNames
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
public java.lang.String[] listDisplayNames() throws DKException
dkSearchTemplate
listDisplayNames
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
public short getParametricOp()
getParametricOp
in interface dkSearchTemplate
entityName
- name of entityDKException
- if error occurspublic void setParametricOp(short critOp)
setParametricOp
in interface dkSearchTemplate
entityName
- name of entitycritOp
- the operatorDKException
- if error occurspublic int[] getSortOrders()
getSortOrders
in interface dkSearchTemplate
DKException
- if error occurspublic void setSortOrders(int[] sortOrders)
setSortOrders
in interface dkSearchTemplate
the
- sort order arrayDKException
- if error occurspublic void addUser(java.lang.String name, short access) throws DKException
dkSearchTemplate
addUser
in interface dkSearchTemplate
com.ibm.mm.sdk.common.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
dkSearchTemplate
addGroup
in interface dkSearchTemplate
com.ibm.mm.sdk.common.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
dkSearchTemplate
removeUser
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
name
- userid name to be removedpublic void removeGroup(java.lang.String name) throws DKException
dkSearchTemplate
removeGroup
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
name
- group name to be removedpublic java.lang.String[] listUsers() throws DKException
dkSearchTemplate
listUsers
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
public java.lang.String[] listGroups() throws DKException
dkSearchTemplate
listGroups
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
public DKCQExpr createQueryExpr() throws DKException
dkSearchTemplate
createQueryExpr
in interface dkSearchTemplate
com.ibm.mm.sdk.common.dkSearchTemplate
serverName
- the name of the destination server.public short getNumCrit() throws DKDatastoreAccessError
DKException
- if error occurspublic int getNumFields() throws DKDatastoreAccessError
public short getNumQueryCrit() throws DKDatastoreAccessError
DKException
- if error occurspublic int[] getQueryOrder() throws DKDatastoreAccessError
DKException
- if error occurspublic short getNumDisplayCrit() throws DKDatastoreAccessError
DKException
- if error occurspublic int[] getDisplayOrder() throws DKDatastoreAccessError
DKException
- if error occurspublic short getNumSortCrit() throws DKDatastoreAccessError
DKException
- if error occurspublic java.lang.String critName(short fldId) throws DKDatastoreAccessError
fldId
- the id of the search criteriaDKException
- if error occurspublic com.ibm.mm.sdk.internal.PFieldStructOD[] getFieldInfo() throws java.lang.Exception
DKException
- if error occurspublic DKSearchCriteria[] getCritInfo() throws DKDatastoreAccessError
DKException
- if error occurspublic dkAttrDef createAttr() throws DKException, java.lang.Exception
dkAbstractEntityDef
Note:DKUsageError exception thrown if method is not implemented
createAttr
in class dkAbstractEntityDef
com.ibm.mm.sdk.common.dkAbstractEntityDef
DKException
- if this entity does not have attributepublic dkAttrDef getAttr(java.lang.String attrName) throws DKException, java.lang.Exception
dkAbstractEntityDef
Note:DKUsageError exception thrown if method is not implemented
getAttr
in class dkAbstractEntityDef
com.ibm.mm.sdk.common.dkAbstractEntityDef
attrName
- name of attribute to be retrievedDKException
- if the attribute name is not existpublic dkCollection listAttrs() throws DKException, java.lang.Exception
dkAbstractEntityDef
listAttrs
in class dkAbstractEntityDef
com.ibm.mm.sdk.common.dkAbstractEntityDef
DKException
- if error occurspublic java.lang.String[] listAttrNames() throws DKException, java.lang.Exception
dkAbstractEntityDef
listAttrNames
in class dkAbstractEntityDef
com.ibm.mm.sdk.common.dkAbstractEntityDef
DKException
- if error occurspublic void clearCache() throws DKException, java.lang.Exception
dkSearchTemplate
clearCache
in interface dkSearchTemplate
clearCache
in class dkAbstractEntityDef
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |