Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKViewDataOD

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKSequentialCollection
        |
        +--com.ibm.mm.sdk.common.DKViewDataOD
All Implemented Interfaces:
dkCollection, DKConstant, dkDataObjectBase, DKMessageId, java.io.Serializable

public class DKViewDataOD
extends DKSequentialCollection
implements dkDataObjectBase, DKConstant, java.io.Serializable

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().

See Also:
Serialized Form

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

DKViewDataOD

public DKViewDataOD()
Constructs a DKViewDataOD object.

DKViewDataOD

public DKViewDataOD(DKViewDataOD aDKViewDataOD)
             throws DKUsageError
Constructs a DKViewDataOD object.
Parameters:
aDKViewDataOD -  
Method Detail

protocol

public short protocol()
Gets the protocol type associated with this data object.
Specified by:
protocol in interface dkDataObjectBase
Returns:
the protocol

getObjectType

public java.lang.String getObjectType()
Gets the type of this object.
Specified by:
getObjectType in interface dkDataObjectBase
Returns:
the object type

getNumViewData

public int getNumViewData()
Return the number of views defined in this collection
Returns:
int the number of views

getViewData

public DKViewDataDefOD getViewData(java.lang.String name)
                            throws DKException
Return a specified view
Parameters:
name - the view to return
Returns:
DKViewDataDefOD the view definition

listViewNames

public java.lang.String[] listViewNames()
                                 throws DKException
Return an array of the view names
Returns:
String[] of view names

removeViewData

public void removeViewData(DKViewDataDefOD view)
                    throws DKException
Remove a view from the datastore
Parameters:
view - DKViewDataDefOD object to remove

retrieveViewData

public void retrieveViewData()
                      throws DKException
Get view data from datastore

updateViewData

public void updateViewData(DKViewDataDefOD view)
                    throws DKException
Modified the specified view in the datastore
Parameters:
view - DKViewDataDefOD object to update

getParent

public dkDataObjectBase getParent()
Gets the parent object
Specified by:
getParent in interface dkDataObjectBase
Returns:
the parent object. Returns null if no parent

setParent

public void setParent(dkDataObjectBase parentObject)
Sets the parent object
Specified by:
setParent in interface dkDataObjectBase
Parameters:
parent - the parent object

getRootObject

public dkDataObjectBase getRootObject()
Gets the root object
Specified by:
getRootObject in interface dkDataObjectBase
Returns:
the root object. Returns null if no root

setRootObject

public void setRootObject(dkDataObjectBase rootObject)
Sets the root object
Specified by:
setRootObject in interface dkDataObjectBase
Parameters:
rootObject - the root object

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.