Interface for an ID parameter. More...

#include <IIdParam.h>

Inheritance diagram for iprm::IIdParam:

Public Member Functions
virtual QByteArray	GetId () const =0
	Get the object ID.

virtual void	SetId (const QByteArray &id)=0
	Set the object ID.

Public Member Functions inherited from iser::ISerializable
virtual bool	Serialize (IArchive &archive)=0
	Load or store state of this object as a archive stream.

virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.

Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual istd::TUniqueInterfacePtr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Additional Inherited Members
Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ACF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Interface for an ID parameter.

IIdParam stores a unique identifier as a QByteArray. It's typically used for internal identification, serialization keys, or database IDs where a binary-safe identifier is needed.

Usage Example

#include <iprm/CIdParam.h>
 
// Create an ID parameter
iprm::CIdParam idParam;
 
// Set ID
idParam.SetId("user_123");
 
// Get ID
QByteArray id = idParam.GetId();
qDebug() << "ID:" << id;
 
// IDs can contain binary data
QByteArray binaryId = QByteArray::fromHex("deadbeef");
idParam.SetId(binaryId);

Comparison with Other Parameter Types

IIdParam: Uses QByteArray, suitable for binary-safe identifiers
INameParam: Uses QString, suitable for human-readable names
ITextParam: Uses QString, suitable for general text content

Note: Inherits from iser::ISerializable for persistence support.; IDs are typically used as stable references that don't change over time.

See also: CIdParam, INameParam, ITextParam

Definition at line 54 of file IIdParam.h.

Member Function Documentation

◆ GetId()

virtual QByteArray iprm::IIdParam::GetId ( ) const

pure virtual

Get the object ID.

Returns: The current ID as QByteArray.

QByteArray id = idParam.GetId();
if (!id.isEmpty())
{
    qDebug() << "ID:" << id;
}

See also: SetId

Implemented in iprm::CIdParam.

◆ SetId()

virtual void iprm::IIdParam::SetId ( const QByteArray & id )

pure virtual

Set the object ID.

Changes the identifier value.

Parameters

id	New ID value. Can be empty or contain binary data.

// Set text-based ID
idParam.SetId("entity_42");
 
// Set binary ID
QByteArray binaryId = QByteArray::fromHex("1234abcd");
idParam.SetId(binaryId);
 
// Clear ID
idParam.SetId(QByteArray());

See also: GetId