Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKPidICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKPid
        |
        +--com.ibm.mm.sdk.common.DKPidICM
All Implemented Interfaces:
DKMessageId, java.io.Serializable

public class DKPidICM
extends DKPid
implements java.io.Serializable

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKPidICM()
          Constructs a Pid
DKPidICM(DKPidICM pidICM)
          Constructs a Pid object for datastore ICM.
DKPidICM(java.lang.String aPidString)
          Constructs a Pid using a previously created string form of this Pid.
 
Method Summary
 java.lang.Object clone()
          Clone this Pid instance.
 boolean equals(java.lang.Object otherObject)
          Compares two Pids for equality.
 java.lang.String getComponentId()
          Gets the component identifier.
 java.lang.String getComponentTypeId()
          Gets the the component type identifier.
 java.lang.String getItemId()
          Gets the Item identifier
 java.lang.String getPrimaryId()
          Gets the datastore specific primary persistent-identifier.
 java.lang.String getVersionNumber()
          Gets the version number
 java.lang.String pidType()
          Gets the Pid type.
 void setComponentId(java.lang.String aCompId)
          Sets the component identifier.
 void setComponentTypeId(java.lang.String aCompTypeId)
          Sets the component type identifier in this Pid.
 void setItemId(java.lang.String aItemId)
          Sets the Item identifier
 void setPrimaryId(java.lang.String primaryId)
          Sets the datastore specific primary persistent-identifier.
 void setVersionNumber(java.lang.String aVerNum)
          Sets the version number
 
Methods inherited from class com.ibm.mm.sdk.common.DKPid
getDatastoreName, getDatastoreType, getId, getIdString, getIdString, getIdStringCount, getObjectType, isSet, pidString, setDatastoreName, setDatastoreType, setId, setIdString, setIdString, setIdStringCount, setObjectType
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKPidICM

public DKPidICM()
Constructs a Pid

DKPidICM

public DKPidICM(java.lang.String aPidString)
         throws DKException
Constructs a Pid using a previously created string form of this Pid.
Parameters:
aPidString - pid string. This string is usually obtained as a result of the DKPidICM.toPidString() method.

DKPidICM

public DKPidICM(DKPidICM pidICM)
Constructs a Pid object for datastore ICM.
Parameters:
pidICM - the pid for ICM
Method Detail

getPrimaryId

public java.lang.String getPrimaryId()
Gets the datastore specific primary persistent-identifier. Returns the ItemId. For datastoreICM, the primary identifier is the item identifier. Overrides: getPrimaryId in class DKPid
Overrides:
getPrimaryId in class DKPid
Returns:
the datastore primary identifier

setPrimaryId

public void setPrimaryId(java.lang.String primaryId)
Sets the datastore specific primary persistent-identifier. Overrides: setPrimaryId in class DKPid
Overrides:
setPrimaryId in class DKPid
Parameters:
primaryId - primary persistent-identifier for this datastore.

getItemId

public java.lang.String getItemId()
Gets the Item identifier
Returns:
the item identifier

setItemId

public void setItemId(java.lang.String aItemId)
Sets the Item identifier
Parameters:
aItemId - the item identifier

getComponentId

public java.lang.String getComponentId()
Gets the component identifier.
Returns:
the component identifier.

setComponentId

public void setComponentId(java.lang.String aCompId)
Sets the component identifier.
Parameters:
aCompId - the component identifier.

getVersionNumber

public java.lang.String getVersionNumber()
Gets the version number
Returns:
the version number

setVersionNumber

public void setVersionNumber(java.lang.String aVerNum)
Sets the version number
Parameters:
aVerNum - a version number

getComponentTypeId

public java.lang.String getComponentTypeId()
Gets the the component type identifier.
Returns:
the the component type identifier.

setComponentTypeId

public void setComponentTypeId(java.lang.String aCompTypeId)
Sets the component type identifier in this Pid.
Parameters:
aCompId - the component type identifier.

equals

public boolean equals(java.lang.Object otherObject)
Compares two Pids for equality.
Overrides:
equals in class DKPid
Returns:
true if these two Pids are equals.

clone

public java.lang.Object clone()
Clone this Pid instance. Overrides: clone in class DKPid
Overrides:
clone in class DKPid
Returns:
the a copy of Pid

pidType

public java.lang.String pidType()
Gets the Pid type. Overrides: pidType in class DKPid
Overrides:
pidType in class DKPid
Returns:
the pid type, that is "DKPidICM".

EIP Java APIs

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