|
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.DKSequentialCollection | +--com.ibm.mm.sdk.common.DKViewDataOD
DKViewDataOD is a subclass of sequential collection. Its purpose is to hold
logical views of a document object.
The DDO representing a document has an attribute with reserved name of
DKViewDataOD
, its value is a reference to this collection.
DKViewDataOD inherits the public interface of sequential collection.
In addition to the inherited
methods, DKParts has two additional methods: addMember()
and
removeMember()
.
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 | |
DKViewDataOD()
Constructs a DKViewDataOD object. |
|
DKViewDataOD(DKViewDataOD aDKViewDataOD)
Constructs a DKViewDataOD object. |
Method Summary | |
int |
getNumViewData()
Return the number of views defined in this collection |
java.lang.String |
getObjectType()
Gets the type of this object. |
dkDataObjectBase |
getParent()
Gets the parent object |
dkDataObjectBase |
getRootObject()
Gets the root object |
DKViewDataDefOD |
getViewData(java.lang.String name)
Return a specified view |
java.lang.String[] |
listViewNames()
Return an array of the view names |
short |
protocol()
Gets the protocol type associated with this data object. |
void |
removeViewData(DKViewDataDefOD view)
Remove a view from the datastore |
void |
retrieveViewData()
Get view data from datastore |
void |
setParent(dkDataObjectBase parentObject)
Sets the parent object |
void |
setRootObject(dkDataObjectBase rootObject)
Sets the root object |
void |
updateViewData(DKViewDataDefOD view)
Modified the specified view in the datastore |
Methods inherited from class com.ibm.mm.sdk.common.DKSequentialCollection |
addElement, cardinality, createIterator, getAssociatedAttrName, getName, getOwner, getSortFunction, insertElementAt, removeAllElements, removeElementAt, replaceElementAt, retrieveElementAt, setName, setSortFunction, sort, sort, sort |
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.dkCollection |
addAllElements |
Constructor Detail |
public DKViewDataOD()
public DKViewDataOD(DKViewDataOD aDKViewDataOD) throws DKUsageError
aDKViewDataOD
- Method Detail |
public short protocol()
protocol
in interface dkDataObjectBase
public java.lang.String getObjectType()
getObjectType
in interface dkDataObjectBase
public int getNumViewData()
public DKViewDataDefOD getViewData(java.lang.String name) throws DKException
name
- the view to returnpublic java.lang.String[] listViewNames() throws DKException
public void removeViewData(DKViewDataDefOD view) throws DKException
view
- DKViewDataDefOD object to removepublic void retrieveViewData() throws DKException
public void updateViewData(DKViewDataDefOD view) throws DKException
view
- DKViewDataDefOD object to updatepublic dkDataObjectBase getParent()
getParent
in interface dkDataObjectBase
public void setParent(dkDataObjectBase parentObject)
setParent
in interface dkDataObjectBase
parent
- the parent objectpublic dkDataObjectBase getRootObject()
getRootObject
in interface dkDataObjectBase
public void setRootObject(dkDataObjectBase rootObject)
setRootObject
in interface dkDataObjectBase
rootObject
- the root object
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |