|
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.DKAutoLinkDefICM
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 |
public DKAutoLinkDefICM()
public DKAutoLinkDefICM(dkDatastore ds)
ds
- - A reference to a datastore object where the item type, whose auto
links this object represents is definedpublic DKAutoLinkDefICM(dkDatastore ds, java.lang.String targetEntityName, java.lang.String linkType, java.lang.String attrName)
ds
- - A reference to a datastore object where the item type, whose auto
links this object represents is definedtargetEntityName
- - the name of the target item typelinkType
- - the type of link. e.g. 'contains', 'DKFolder'attrName
- - attribute namepublic DKAutoLinkDefICM(DKAutoLinkDefICM autoLnk)
autoLnk
- - an auto link objectpublic DKAutoLinkDefICM(dkDatastore ds, java.lang.String targetEntityName, java.lang.String linkType, java.lang.String attrName, java.lang.String attrGroupName)
ds
- - A reference to a datastore object where the item type, whose auto
links this object represents is definedtargetEntityName
- - the name of the target item typelinkType
- - the type of link. e.g. 'contains', 'DKFolder'attrName
- - attribute nameattrGroupName
- - attribute group nameMethod Detail |
public void setDatastore(dkDatastore ds)
ds
- - an ICM datastorepublic dkDatastore getDatastore()
public void add() throws DKException, java.lang.Exception
if
- an error occurspublic void update() throws DKException, java.lang.Exception
if
- an error occurspublic void delete() throws DKException, java.lang.Exception
if
- an error occurspublic void setTargetEntityName(java.lang.String tgtEntName)
tgtEntName
- - target item type name. The length of target item type name
can be up to 32 characters longpublic java.lang.String getTargetEntityName()
setTargetEntityName(String)
public void setSourceEntityName(java.lang.String srcEntName)
String
- source item type namepublic java.lang.String getSourceEntityName()
public void setAttrGroupName(java.lang.String attrGroupName)
String
- attribute group namepublic java.lang.String getAttrGroupName()
public int getSequenceNo()
public void setSequenceNo(short seqNum)
seqNum
- - sequence number of this auto link with respect to the other auto links
defined in this item type
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |