|
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.dkAbstractDatastoreDef | +--com.ibm.mm.sdk.common.DKDatastoreDefFed
This class defines methods to access federated datastore information as well as to:
In this class, there additional methods to access search templates and back-end servers information.
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
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 |
Constructor Summary | |
DKDatastoreDefFed(dkDatastore ds)
Constructs a new DKDatastoreDefFed object with a given datastore |
Method Summary | |
void |
add(dkEntityDef entityObj)
Adds this given federated schema def object to the persistent datastore. |
dkEntityDef |
createEntity()
Creates a new dkEntityDef and return it. |
dkDatastoreAdmin |
datastoreAdmin()
Gets the reference to dkDatastoreAdmin object |
void |
del(dkEntityDef entityObj)
Deletes this given federated schema def object from persistent Federated datastore, i.e., deletes an federated schema from this Federated server. |
dkEntityDef |
getEntity(java.lang.String entityName)
Gets the dkEntityDef object for the given entity name from persistent datastore. |
dkSearchTemplate |
getSearchTemplate(java.lang.String templateName)
Gets the search template object for the given name from persistent datastore. |
dkCollection |
listEntities()
Gets a list of entities from persistent datastore |
java.lang.String[] |
listEntityAttrNames(java.lang.String entityName)
Gets a list of attribute names for a given entity name. |
dkCollection |
listEntityAttrs(java.lang.String entityName)
Gets a list of attributes for a given entity name. |
java.lang.String[] |
listEntityNames()
Gets a list of entity names from persistent datastore |
java.lang.String[] |
listEntityNames(java.lang.String nativeServerName)
Gets a list of entity names for the specified native server name |
java.lang.String[] |
listNativeEntityNames(java.lang.String fedEntityName,
java.lang.String serverName)
Gets a list of native entity names for the specified federate entity name |
java.lang.String[] |
listParmEntityNames()
Gets a list of parametric search entity names from persistent datastore |
java.lang.String[] |
listSchemaMappingNamesByServer(java.lang.String serverName)
Gets a list of schema mapping names defined for the given server. |
java.lang.String[] |
listSearchTemplateNames()
Gets a list of defined search template folders from this Federated server. |
dkCollection |
listSearchTemplates()
Gets a list of defined search template folders from this Federated server. |
java.lang.String[] |
listTextEntityNames()
Gets a list of text search entity names from persistent datastore |
dkSearchTemplate |
newSearchTemplate()
Creates a new search template folder object. |
void |
retrieve(dkEntityDef entityObj)
Updates this given federated schema def object to persistent Federated datastore, i.e., updates an federated schema to this Federated server. |
void |
update(dkEntityDef entityObj)
Updates this given federated schema def object to persistent Federated datastore, i.e., updates an federated schema to this Federated server. |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDatastoreDef |
clearCache, datastoreName, datastoreType, deleteEntity, getDatastore, listEntities, listEntities, listEntityNames, listEntityNames, listSearchableEntities, listSearchableEntities, listSearchableEntities, listSearchableEntityNames, listSearchableEntityNames, listSearchableEntityNames, retrieveEntity, setDatastore |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKDatastoreDefFed(dkDatastore ds) throws DKException, java.lang.Exception
ds
- reference to the datastore objectMethod Detail |
public dkEntityDef createEntity() throws DKException, java.lang.Exception
createEntity
in class dkAbstractDatastoreDef
public dkEntityDef getEntity(java.lang.String entityName) throws DKException, java.lang.Exception
getEntity
in class dkAbstractDatastoreDef
entityName
- name of entity to retrieveDKException
- if the entity name is not existpublic dkCollection listEntities() throws DKException, java.lang.Exception
listEntities
in class dkAbstractDatastoreDef
DKException
- if error occurspublic java.lang.String[] listEntityNames() throws DKException, java.lang.Exception
listEntityNames
in class dkAbstractDatastoreDef
DKException
- if error occurspublic java.lang.String[] listEntityNames(java.lang.String nativeServerName) throws DKException, java.lang.Exception
nativeServerName
- the native server nameDKException
- if error occurspublic java.lang.String[] listNativeEntityNames(java.lang.String fedEntityName, java.lang.String serverName) throws DKException, java.lang.Exception
fedEntityName
- a federate entity nameserverName
- a native server nameDKException
- if error occurspublic java.lang.String[] listTextEntityNames() throws DKException, java.lang.Exception
DKException
- if error occurspublic java.lang.String[] listParmEntityNames() throws DKException, java.lang.Exception
DKException
- if error occurspublic dkCollection listEntityAttrs(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrs
in class dkAbstractDatastoreDef
entityName
- name of entity to retrieve attributes forDKException
- if the entity name does not existpublic java.lang.String[] listEntityAttrNames(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrNames
in class dkAbstractDatastoreDef
entityName
- name of entity to retrieve attribute names forDKException
- if the entity name does not existpublic java.lang.String[] listSchemaMappingNamesByServer(java.lang.String serverName) throws DKException, java.lang.Exception
serverName
- the server nameDKException
- if error occurspublic dkSearchTemplate newSearchTemplate() throws DKException, java.lang.Exception
public dkSearchTemplate getSearchTemplate(java.lang.String templateName) throws DKException, java.lang.Exception
templateName
- name of search template to retrieveDKException
- if the search template name is not existpublic dkCollection listSearchTemplates() throws DKException, java.lang.Exception
listSearchTemplates
in class dkAbstractDatastoreDef
DKException
- if error occurs in serverpublic java.lang.String[] listSearchTemplateNames() throws DKException, java.lang.Exception
listSearchTemplateNames
in class dkAbstractDatastoreDef
DKException
- if error occurs in serverpublic void add(dkEntityDef entityObj) throws DKException, java.lang.Exception
add
in class dkAbstractDatastoreDef
entityObj
- an federated schema object to be added.DKException
- if entityObj is invalid.public void del(dkEntityDef entityObj) throws DKException, java.lang.Exception
del
in class dkAbstractDatastoreDef
entityObj
- federated schema object to be deletedDKException
- if "entityObj" is invalid.public void update(dkEntityDef entityObj) throws DKException, java.lang.Exception
entityObj
- federated schema object to be updatedDKException
- if "entityObj" is invalid.public void retrieve(dkEntityDef entityObj) throws DKException, java.lang.Exception
entityObj
- federated schema object to be updatedDKException
- if "entityObj" is invalid.public dkDatastoreAdmin datastoreAdmin() throws DKException, java.lang.Exception
datastoreAdmin
in class dkAbstractDatastoreDef
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |