|
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.DKEntityDefFed
DKEntityDefFed class defines methods to access federated entity 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.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 |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKEntityDefFed()
Default constructor with no parameter. |
|
DKEntityDefFed(dkDatastore ds)
Constructs a new dkEntityDefDefault class with owner datastore object |
Method Summary | |
void |
add()
Adds this entity definition to the federated data store, that is, make this entity persistent. |
void |
add(dkAttrDef attrObj)
Adds the given attribute definition object to the this entity in the persistent store. |
void |
addAttr(dkAttrDef attrObj)
Adds the given attribute definition object to this entity in memory only |
void |
addSchemaMapping(dkSchemaMapping smObj)
Add another mapping definition of this entity, usually a new mapping to another back-end server. |
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. |
void |
delAttr(dkAttrDef attrObj)
Deletes the given attribute definition object from this entity in memory only |
dkAttrDef |
getAttr(java.lang.String attrName)
Retrieves an attribute object from a given attribute name |
dkServerDef |
getDataSource(java.lang.String dataSourceName)
Gets a list of datasource definition objects |
dkSchemaMapping |
getSchemaMapping(java.lang.String smName)
Gets a schema mapping object from the given schema mapping name |
java.lang.String[] |
listAttrNames()
Gets a list of attribute names. |
dkCollection |
listAttrs()
Gets a list of attributes |
java.lang.String[] |
listDataSourceNames()
Gets a list of datasource names |
dkCollection |
listDataSources()
Gets a list of datasource definition objects |
java.lang.String[] |
listSchemaMappingNames()
Gets a list of schema mapping names |
java.lang.String[] |
listSchemaMappingNamesByServer(java.lang.String serverName)
Gets schema mapping objects associated with a given server. |
dkCollection |
listSchemaMappings()
Gets a collection of all schema mapping classes defined for this entity. |
void |
removeSchemaMapping(java.lang.String smName)
Removes a schema mapping from this entity. |
void |
setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object |
void |
update()
sshi 12-18-2001 update Adds this entity definition to the federated data store, that is, make this entity persistent. |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef |
add, addSubEntity, clearCache, createSubEntity, datastoreName, datastoreType, del, deleteAttr, deleteSubEntity, getDatastore, getDescription, getName, getParentEntityName, getSubEntity, getType, hasSubEntities, isSearchable, isTextSearchable, listSubEntities, listSubEntityNames, removeAttr, removeSubEntity, retrieveAttr, retrieveSubEntity, setDescription, setName, setParentEntityName, setTextSearchable, setType |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKEntityDefFed()
public DKEntityDefFed(dkDatastore ds) throws DKException, java.lang.Exception
ds
- reference to owner datastore objectMethod Detail |
public void setDatastore(dkDatastore ds)
setDatastore
in class dkAbstractEntityDef
com.ibm.mm.sdk.common.dkEntityDef
ds
- datastorepublic 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
listAttrNames
in class dkAbstractEntityDef
DKException
- if error occurspublic void add() throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
DKException
- when there is error from the back-end serverpublic void update() throws DKException, java.lang.Exception
DKException
- when there is error from the back-end serverpublic void del() throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
DKException
- when there is errorpublic 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 void addAttr(dkAttrDef attrObj)
addAttr
in class dkAbstractEntityDef
attrObj
- an attribute object to be added to this entity objectpublic void delAttr(dkAttrDef attrObj)
attrObj
- an attribute object to be added to this entity objectpublic void addSchemaMapping(dkSchemaMapping smObj) throws DKException, java.lang.Exception
smObj
- a schema mapping definition object, dkSchemaMapping.public void removeSchemaMapping(java.lang.String smName) throws DKException, java.lang.Exception
smName
- name of the schema mapping to be removed.public dkSchemaMapping getSchemaMapping(java.lang.String smName) throws DKException, java.lang.Exception
smName
- name of the schema mapping object to retrievepublic java.lang.String[] listSchemaMappingNamesByServer(java.lang.String serverName) throws DKException
serverName
- server namepublic dkCollection listSchemaMappings() throws DKException, java.lang.Exception
public java.lang.String[] listSchemaMappingNames() throws DKException
public dkServerDef getDataSource(java.lang.String dataSourceName) throws DKException, java.lang.Exception
DKException
- if dataSourceName is not yet definedpublic dkCollection listDataSources() throws DKException, java.lang.Exception
DKException
- if error occurs in serverpublic java.lang.String[] listDataSourceNames() throws DKException, java.lang.Exception
DKException
- if error occurs when retrieving datasource names
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |