|
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.DKPid
This class represents a PID (Persistent identifier) object. A persistent data identifier (PID) is a unique identifier for locating persistent data objects in a set of known datastores. A dkDataObject must have a PID in order to store its data.
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKPid()
Constructs a PID object |
|
DKPid(DKPid pid)
Constructs a PID from another PID |
|
DKPid(int idStringCount)
Constructs a PID object |
|
DKPid(java.lang.String sourcePidString)
Constructs a PID object from a PID string representation. |
Method Summary | |
java.lang.Object |
clone()
Clone |
boolean |
equals(java.lang.Object otherObject)
Compares this PID if it is equal to another PID. |
java.lang.String |
getDatastoreName()
Gets the datastore name from this PID |
java.lang.String |
getDatastoreType()
Gets the datastore type from this PID |
java.lang.String |
getId()
Deprecated. Replace by getPrimaryId |
java.lang.String |
getIdString()
Gets the datastore specific persistent-id of the owner data-object. |
java.lang.String |
getIdString(int index)
Gets id string by index (0 to n-1) |
int |
getIdStringCount()
Gets id string count |
java.lang.String |
getObjectType()
Gets the type of the data-object owning this PID |
java.lang.String |
getPrimaryId()
Gets the datastore specific primary persistent-id |
boolean |
isSet()
Returns true if all components of this Pid are set to their intended values. |
java.lang.String |
pidString()
Gets the string representation of the PID. |
java.lang.String |
pidType()
Gets the PID type |
void |
setDatastoreName(java.lang.String sourceDatastoreName)
Sets the datastore name of this PID |
void |
setDatastoreType(java.lang.String sourceDatastoreType)
Sets the datastore type of this PID |
void |
setId(java.lang.String sourceId)
Deprecated. Replace by setPrimaryId |
void |
setIdString(int index,
java.lang.String idStringItem)
Sets id string by index (0 to n-1) |
void |
setIdString(java.lang.String sourceId)
Sets the datastore specific persistent-id for the owner data-object. |
void |
setIdStringCount(int idStringCount)
Sets id string count |
void |
setObjectType(java.lang.String sourceObjectType)
Sets the type of the data-object owning this Pid. |
void |
setPrimaryId(java.lang.String primaryId)
Sets the datastore specific primary persistent-id |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKPid()
public DKPid(int idStringCount)
idStringCount
- string id countpublic DKPid(java.lang.String sourcePidString) throws DKException
sourcePidString
- the PID string, a string obtained by calling the
pidString()
method in the PIDpublic DKPid(DKPid pid)
pid
- the other PIDMethod Detail |
public java.lang.String getDatastoreType()
public void setDatastoreType(java.lang.String sourceDatastoreType)
sourceDatastoreType
- datastore type.public java.lang.String getDatastoreName()
public void setDatastoreName(java.lang.String sourceDatastoreName)
sourceDatastoreName
- datastore namepublic java.lang.String getId()
getPrimaryId()
public void setId(java.lang.String sourceId)
sourceId
- datastore persistent-idsetPrimaryId(java.lang.String)
public java.lang.String getIdString()
public void setIdString(java.lang.String sourceId)
sourceId
- datastore persistent-idpublic java.lang.String getPrimaryId()
public void setPrimaryId(java.lang.String primaryId)
primaryId
- datastore primary persistent-idpublic java.lang.String pidString()
DKPid(String sourcePidString).
public java.lang.String getObjectType()
public void setObjectType(java.lang.String sourceObjectType)
toObjectType
- the object typepublic boolean isSet()
public int getIdStringCount()
public void setIdStringCount(int idStringCount)
idStringCount
- the id string countpublic java.lang.String getIdString(int index) throws DKException
index
- the index of a part of the id stringpublic void setIdString(int index, java.lang.String idStringItem) throws DKException
index
- the index of a part of the id stringidStringItem
- a part of the id stringpublic boolean equals(java.lang.Object otherObject)
equals
in class java.lang.Object
otherObject
- the other PIDpublic java.lang.Object clone()
public java.lang.String pidType()
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |