|
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.DKDatabaseDefDES
DKDatabaseDefDES class defines methods to access DES entity information
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 | |
DKDatabaseDefDES()
Default constructor with no parameter. |
|
DKDatabaseDefDES(dkDatastore ds)
Constructs a new DKDatabaseDefDES class with owner datastore object |
Method Summary | |
void |
add()
Adds this entity definition to the persistent store, i.e. |
void |
add(dkAttrDef attrObj)
Adds the given attribute definition object to the this entity in the persistent store. |
dkAttrDef |
createAttr()
Creates new dkAttrDef and returns it to caller. |
void |
del()
Deletes this entity from the persistent store, e.g. |
void |
del(dkAttrDef attrObj)
Deletes the given attribute from this entity in the persistent store. |
dkAttrDef |
getAttr(java.lang.String attrName)
Retrieves an attribute object from a given attribute name |
java.lang.String |
getDisplayName()
Get the display name of the database. |
java.lang.String |
getHelpText()
Get the help text |
java.lang.String |
getLanguage()
Get the language. |
int |
getNumVals()
Get the number of values |
int |
getSchema()
Get the schema |
boolean |
isTextSearchable()
Checks if this entity is text searchable. |
java.lang.String[] |
listAttrNames()
Gets a list of attributes |
dkCollection |
listAttrs()
Gets a list of attributes |
void |
setDisplayName(java.lang.String dispName)
Set the display name of the database. |
void |
setHelpText(java.lang.String txt)
Set the help text |
void |
setLanguage(java.lang.String lang)
Set the language. |
void |
setNumValues(int num)
Set the number of values |
void |
setSchema(int schema)
Set the schema |
void |
setTextSearchable(boolean textSearchable)
Sets this entity to be text searchable |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef |
add, addAttr, addSubEntity, clearCache, createSubEntity, datastoreName, datastoreType, del, deleteAttr, deleteSubEntity, getDatastore, getDescription, getName, getParentEntityName, getSubEntity, getType, hasSubEntities, isSearchable, listSubEntities, listSubEntityNames, removeAttr, removeSubEntity, retrieveAttr, retrieveSubEntity, setDatastore, setDescription, setName, setParentEntityName, setType |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKDatabaseDefDES() throws DKException, java.lang.Exception
public DKDatabaseDefDES(dkDatastore ds) throws DKException, java.lang.Exception
ds
- reference to owner datastore objectMethod Detail |
public dkAttrDef createAttr() throws DKException, java.lang.Exception
createAttr
in class dkAbstractEntityDef
DKException
- if this entity does not have attributepublic dkAttrDef getAttr(java.lang.String attrName) throws DKException, java.lang.Exception
getAttr
in class dkAbstractEntityDef
attrName
- name of attribute to be retrievedDKException
- if the attribute name is not existpublic dkCollection listAttrs() throws DKException, java.lang.Exception
listAttrs
in class dkAbstractEntityDef
DKException
- if error occurspublic java.lang.String[] listAttrNames() throws DKException, java.lang.Exception
listAttrNames
in class dkAbstractEntityDef
DKException
- if error occurspublic void add() throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
DKException
- when the subclass does not
implement this methodpublic void del() throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
DKException
- when the subclass does not implement this methodpublic void add(dkAttrDef attrObj) throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
attrObj
- an attribute object to be added to this entity objectDKException
- if there is error in datastore serverpublic void del(dkAttrDef attrObj) throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
attrObj
- an attribute object to be deleted from this entity objectDKException
- if the error occurs in datastorepublic java.lang.String getDisplayName()
public void setDisplayName(java.lang.String dispName)
display
- namepublic java.lang.String getLanguage()
public void setLanguage(java.lang.String lang)
language
- public java.lang.String getHelpText()
public void setHelpText(java.lang.String txt)
help
- textpublic int getSchema()
public void setSchema(int schema)
schema
- public int getNumVals()
public void setNumValues(int num)
number
- of valuespublic boolean isTextSearchable()
isTextSearchable
in class dkAbstractEntityDef
public void setTextSearchable(boolean textSearchable) throws DKException, java.lang.Exception
setTextSearchable
in class dkAbstractEntityDef
textSearchable
- is true if the entity is text searchable
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |