Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAutoLinkDefICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKAutoLinkDefICM
All Implemented Interfaces:
DKConstant, DKConstantICM, DKMessageId, DKMessageIdICM

public class DKAutoLinkDefICM
extends java.lang.Object
implements DKMessageIdICM, DKConstantICM

Use this class to represent and manage an auto link associated with an item type.


Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Constructor Summary
DKAutoLinkDefICM()
          Default constructor constructs an auto link object
DKAutoLinkDefICM(DKAutoLinkDefICM autoLnk)
          A copy constructor for the auto link object makes a copy of the specified auto link object
DKAutoLinkDefICM(dkDatastore ds)
          Construct an auto link object and initilizes it with the datastore
DKAutoLinkDefICM(dkDatastore ds, java.lang.String targetEntityName, java.lang.String linkType, java.lang.String attrName)
          Construct an auto link object and initilizes it with the datastore, the target item type name, the type of link and the attribute name.
DKAutoLinkDefICM(dkDatastore ds, java.lang.String targetEntityName, java.lang.String linkType, java.lang.String attrName, java.lang.String attrGroupName)
          Construct an auto link object and initilizes it with the datastore, the target item type name, the type of link, the attribute name and the attribute group name.
 
Method Summary
 void add()
          Adds the auto link object to the persistent store.
 void delete()
          Deletes this auto link from the persistent store
 java.lang.String getAttrGroupName()
          gets the attribute group name
 dkDatastore getDatastore()
          Gets the datastore where this auto link object would be persisted.
 int getSequenceNo()
          Gets the sequence number of this auto link with respect to all other auto links defined for the item type
 java.lang.String getSourceEntityName()
          Gets the source item type name
 java.lang.String getTargetEntityName()
          Gets the target item type name to which this auto link object points to
 void setAttrGroupName(java.lang.String attrGroupName)
          sets the attribute group name
 void setDatastore(dkDatastore ds)
          Sets the datastore where this auto link object would be persisted when added to the datastore.
 void setSequenceNo(short seqNum)
          Sets the sequence number of this auto link with respect to all other auto links defined for the item type
 void setSourceEntityName(java.lang.String srcEntName)
          Sets the source item type name
 void setTargetEntityName(java.lang.String tgtEntName)
          Sets the target item type name to which an auto link is to be created
 void update()
          Updates this auto link in the persistent store
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKAutoLinkDefICM

public DKAutoLinkDefICM()
Default constructor constructs an auto link object

DKAutoLinkDefICM

public DKAutoLinkDefICM(dkDatastore ds)
Construct an auto link object and initilizes it with the datastore
Parameters:
ds - - A reference to a datastore object where the item type, whose auto links this object represents is defined

DKAutoLinkDefICM

public DKAutoLinkDefICM(dkDatastore ds,
                        java.lang.String targetEntityName,
                        java.lang.String linkType,
                        java.lang.String attrName)
Construct an auto link object and initilizes it with the datastore, the target item type name, the type of link and the attribute name.
Parameters:
ds - - A reference to a datastore object where the item type, whose auto links this object represents is defined
targetEntityName - - the name of the target item type
linkType - - the type of link. e.g. 'contains', 'DKFolder'
attrName - - attribute name

DKAutoLinkDefICM

public DKAutoLinkDefICM(DKAutoLinkDefICM autoLnk)
A copy constructor for the auto link object makes a copy of the specified auto link object
Parameters:
autoLnk - - an auto link object

DKAutoLinkDefICM

public DKAutoLinkDefICM(dkDatastore ds,
                        java.lang.String targetEntityName,
                        java.lang.String linkType,
                        java.lang.String attrName,
                        java.lang.String attrGroupName)
Construct an auto link object and initilizes it with the datastore, the target item type name, the type of link, the attribute name and the attribute group name.
Parameters:
ds - - A reference to a datastore object where the item type, whose auto links this object represents is defined
targetEntityName - - the name of the target item type
linkType - - the type of link. e.g. 'contains', 'DKFolder'
attrName - - attribute name
attrGroupName - - attribute group name
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the datastore where this auto link object would be persisted when added to the datastore.
Parameters:
ds - - an ICM datastore

getDatastore

public dkDatastore getDatastore()
Gets the datastore where this auto link object would be persisted.
Returns:
ds - an ICM datastore

add

public void add()
         throws DKException,
                java.lang.Exception
Adds the auto link object to the persistent store. By adding an auto link the ICM datastore establishes the auto link facility between the specified source item type and the target item type with the specified attribute name as the link
Throws:
if - an error occurs

update

public void update()
            throws DKException,
                   java.lang.Exception
Updates this auto link in the persistent store
Throws:
if - an error occurs

delete

public void delete()
            throws DKException,
                   java.lang.Exception
Deletes this auto link from the persistent store
Throws:
if - an error occurs

setTargetEntityName

public void setTargetEntityName(java.lang.String tgtEntName)
Sets the target item type name to which an auto link is to be created
Parameters:
tgtEntName - - target item type name. The length of target item type name can be up to 32 characters long

getTargetEntityName

public java.lang.String getTargetEntityName()
Gets the target item type name to which this auto link object points to
Returns:
target item type name
See Also:
setTargetEntityName(String)

setSourceEntityName

public void setSourceEntityName(java.lang.String srcEntName)
Sets the source item type name
Parameters:
String - source item type name

getSourceEntityName

public java.lang.String getSourceEntityName()
Gets the source item type name
Returns:
source item type name

setAttrGroupName

public void setAttrGroupName(java.lang.String attrGroupName)
sets the attribute group name
Parameters:
String - attribute group name

getAttrGroupName

public java.lang.String getAttrGroupName()
gets the attribute group name
Returns:
String attribute group name

getSequenceNo

public int getSequenceNo()
Gets the sequence number of this auto link with respect to all other auto links defined for the item type
Returns:
sequence number of this auto link with respect to the other auto links defined for this item type

setSequenceNo

public void setSequenceNo(short seqNum)
Sets the sequence number of this auto link with respect to all other auto links defined for the item type
Parameters:
seqNum - - sequence number of this auto link with respect to the other auto links defined in this item type

EIP Java APIs

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