com.hp.ucmdb.api.types

Interface UcmdbId

public interface UcmdbId

Method Summary

Modifier and Type	Method and Description
byte[]	getAsBytes() Returns a hexadecimal representation of this ID.
String	getAsString() Returns a string representation of this ID.
boolean	isCalculated() Checks whether this is ID of a calculated CI.
boolean	isExternal() Checks whether this is an external (federated) ID.
boolean	isTemporary() Checks whether this is a temporary ID.

Method Detail

getAsString

String getAsString()

Returns a string representation of this ID. Methods TopologyUpdateFactory.restoreCIIdFromString(String) and TopologyUpdateFactory.restoreRelationIdFromString(String) can be used to restore the ID object back from the string.

If this ID is temporary, its internal string is returned. That is, if the ID is created with TopologyUpdateFactory.createTemporaryCIId(String), the string originally passed to that method is returned.

The restore methods throw an exception when used on strings returned by temporary IDs.

The format of the returned string may change in a future release.
It is guaranteed that the above factory methods will be able to restore IDs from strings returned by this method in previous releases.

getAsBytes

byte[] getAsBytes()

Returns a hexadecimal representation of this ID. Methods TopologyUpdateFactory.restoreCIIdFromBytes(byte[]) and TopologyUpdateFactory.restoreRelationIdFromBytes(byte[]) can be used to restore the ID object back from the bytes array.

When the ID is external an exception is thrown

isTemporary

boolean isTemporary()

Checks whether this is a temporary ID. Temporary IDs are created by the client for topology modification operations with TopologyUpdateFactory.createTemporaryCIId(String) or TopologyUpdateFactory.createCI(String).

isExternal

boolean isExternal()

Checks whether this is an external (federated) ID.

Returns:

isCalculated

boolean isCalculated()

Checks whether this is ID of a calculated CI.

Returns:

true if this is ID of calculated CI and false otherwise