|
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.DKDatastoreDefIC
This class defines methods to access datastore def information in an IC datastore.
DKDatastoreIC
, Serialized FormFields inherited from interface com.ibm.mm.sdk.common.DKConstantIC |
DK_CM_PARM_LINKS, DK_IC_DSTYPE |
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.DKMessageIdIC |
DK_IC_MSG_MSGID_NOT_FOUND |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKDatastoreDefIC(dkDatastore ds)
Constructs a DKDatastoreDefJDBC |
Method Summary | |
void |
add(dkEntityDef entityObj)
Adds the given entity object Not supported in this connector. |
static java.lang.String |
addQuotes(java.lang.String identifier)
Method for replacing single quotes in a literal with a pair of single quotes, making it legal for use in an SQL statement. |
dkEntityDef |
createEntity()
Creates a new dkEntityDef and return it. |
void |
del(dkEntityDef entityObj)
Deletes the given entity object Not supported in this connector. |
dkEntityDef |
getEntity(java.lang.String entityName)
Gets the dkEntityDef object for the given entity name |
dkCollection |
listEntities()
Gets a list of entities ffor the associated 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 for the associated datastore |
static java.lang.String |
literal(java.lang.String identifier)
Method for adding single quotes around a string to make it a legal SQL identifier. |
static java.lang.String |
literal(java.lang.String identifier,
boolean noTrim)
Method for adding single quotes around a string to make it a legal SQL identifier. |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDatastoreDef |
clearCache, datastoreAdmin, datastoreName, datastoreType, deleteEntity, getDatastore, listEntities, listEntities, listEntityNames, listEntityNames, listSearchableEntities, listSearchableEntities, listSearchableEntities, listSearchableEntityNames, listSearchableEntityNames, listSearchableEntityNames, listSearchTemplateNames, listSearchTemplates, retrieveEntity, setDatastore |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKDatastoreDefIC(dkDatastore ds)
ds
- datastore associated with this datastore definitionMethod 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 retrievepublic 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 dkCollection listEntityAttrs(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrs
in class dkAbstractDatastoreDef
entityName
- name of entity to retrieve attributes forpublic 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 forpublic void add(dkEntityDef entityObj) throws DKException, java.lang.Exception
add
in class dkAbstractDatastoreDef
entityObj
- entity object to be added.DKException
- if this method is called.public void del(dkEntityDef entityObj) throws DKException, java.lang.Exception
del
in class dkAbstractDatastoreDef
entityObj
- the entity object to be deleted.if
- this method is calledpublic static java.lang.String literal(java.lang.String identifier)
identifier
- The string identifier to add single quotes to.public static java.lang.String literal(java.lang.String identifier, boolean noTrim)
identifier
- The string identifier to add single quotes to.noTrim
- Determines whether or not leading and trailing
whitespace characters are removed.public static java.lang.String addQuotes(java.lang.String identifier)
identifier
- The string identifier to process
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |