glo::AllSetIteratorResult Class Reference

BasePersistent objects can be queried from the database. If the BasePersistent object is locked, the ObjID should still be delivered. This is the class for the response object. More...

#include <GloAllSetIteratorResult.h>

Public Member Functions
	AllSetIteratorResult ()
	AllSetIteratorResult (const ObjID &rObjID)
	AllSetIteratorResult (Record *pRecord)
virtual	~AllSetIteratorResult ()
ObjID	getObjID () const
Record *	getRecord () const
void	setObjID (const ObjID &rObjID)
void	setRecord (Record *pRecord)

Private Member Functions
	AllSetIteratorResult (const AllSetIteratorResult &)
AllSetIteratorResult &	operator= (const AllSetIteratorResult &)

Private Attributes
ObjID	m_bObjID
Record *	m_pRecord

Detailed Description

BasePersistent objects can be queried from the database. If the BasePersistent object is locked, the ObjID should still be delivered. This is the class for the response object.

See also

PrivateBase::getObjectFromAllSet(ObjID&, BasePersistent*&, const BaseAllSet&, EnSeekMode, bool)const

Author

Helmut Jakoby

Copyright

© 2010 Helmut Jakoby

Constructor & Destructor Documentation

AllSetIteratorResult() [1/4]

glo::AllSetIteratorResult::AllSetIteratorResult

(

)

Standard constructor.

AllSetIteratorResult() [2/4]

glo::AllSetIteratorResult::AllSetIteratorResult

(

const ObjID &

rObjID

)

Constructor with parameter passing.

Parameters

[in]

rObjID

The objID of the found object.

AllSetIteratorResult() [3/4]

glo::AllSetIteratorResult::AllSetIteratorResult

(

Record *

pRecord

)

Constructor with parameter passing.

Parameters

[in]

pRecord

The complete record of the found object. The ObjID is taken from the record in m_bObjID.

Attention

The responsibility for the record is taken by the object of this class, the calling instance must not remove the passed record from memory.

~AllSetIteratorResult()

virtual glo::AllSetIteratorResult::~AllSetIteratorResult ( )

virtual

Destructor

AllSetIteratorResult() [4/4]

glo::AllSetIteratorResult::AllSetIteratorResult ( const AllSetIteratorResult & )

private

The copy constructor is not available.

Member Function Documentation

getObjID()

ObjID glo::AllSetIteratorResult::getObjID

(

)

const

Returns

Returns m_bObjID.

getRecord()

Record * glo::AllSetIteratorResult::getRecord

(

)

const

Returns m_pRecord.

Returns

see above.

Attention

The returned object only lives as long as the object of this class, or only as long as it is not reset! If the record is to be processed further, Record::remember() must be called immediately after pointer assignment.

operator=()

AllSetIteratorResult & glo::AllSetIteratorResult::operator= ( const AllSetIteratorResult & )

private

The assignment operator is not available.

setObjID()

void glo::AllSetIteratorResult::setObjID

(

const ObjID &

rObjID

)

Sets m_bObjID.

Parameters

[in]

rObjID

See above.

Note

A possibly already referenced record is 'forgotten' and set to NULL_PTR.

setRecord()

void glo::AllSetIteratorResult::setRecord

(

Record *

pRecord

)

Sets m_pRecord.

Parameters

[in]

pRecord

The ObjID from the data set in m_bObjID is taken over. Should a NULL_PTR be passed, m_bObjID will be set to NULL.

Attention

The responsibility for the record is taken by the object of this class, the calling instance must not remove the passed record from memory.

Member Data Documentation

m_bObjID

ObjID glo::AllSetIteratorResult::m_bObjID

private

The ObjID. If the read was successful, it is valid.

m_pRecord

Record* glo::AllSetIteratorResult::m_pRecord

private

Pointer to Record, can be NULL_PTR, if e.g. outside the iteration range or if locked.

---

The documentation for this class was generated from the following file:

• GloAllSetIteratorResult.h