OSB_LIB::CpParent Class Reference

Collaboration diagram for OSB_LIB::CpParent:

[legend]List of all members.

---

Detailed Description

Info of the parent connection point.

Definition at line 68 of file connectionpt.h.

Public Types

• typedef Id< ConnectionPt > ParentId

  Object id of the parent.
  

Public Member Functions

• CpParent (const ParentId &parentId, const DateTime &ts=DateTime())

  Constructor with parent id and optional release timestamp.
  

Read access to data members.

• const ParentId & parentId () const

  Return object id of this parent connection point.
  

• long seq () const

  Return the sequence number of the parent relationship.
  

• const CfgStatus & status () const

  Return object status.
  

• const DateTime & releaseTs () const

  Return release date.
  

Modify data members:

• void setReleaseTs (const DateTime &ts)

  Set release date.
  

Status changes:

• bool freeze (OsbErrors &errors)

  Change status from 'editable' to 'standby'.
  

• bool unfreeze (OsbErrors &errors)

  Change status from 'standby' to 'editable'.
  

• bool release (OsbErrors &errors)

  Change status from 'standby' to 'released'.
  

• bool revoke (const ConnectionPt &cp, OsbErrors &errors)

  Change status from 'release' to 'standby'.
  

Private Attributes

• ParentId parentId_

  Object id of the parent connection point.
  

• long seq_

  Sequence of the parent relationship.
  

• CfgStatus status_

  Status of the parent child relationship.
  

• DateTime releaseTs_

  Release date of the parent child relationship.
  

Friends

• class OSB_DB::ConnectionPtGw

  Allow create function at the gateway to assign unique id to newly created parent relationship.
  

• class ConnectionPt

  Allow connection point to directly change the parent relationship to standby when revoking a connection point.
  

---

Member Typedef Documentation

typedef Id<ConnectionPt> OSB_LIB::CpParent::ParentId

Object id of the parent.

Definition at line 82 of file connectionpt.h.

---

Constructor & Destructor Documentation

OSB_LIB::CpParent::CpParent	(	const ParentId &	parentId,
		const DateTime &	ts = DateTime()
	)			[explicit]

Constructor with parent id and optional release timestamp.

---

Member Function Documentation

bool OSB_LIB::CpParent::freeze

(

OsbErrors &

errors

)

Change status from 'editable' to 'standby'.

Parameters:

errors

Container for error messages if any.

Returns:

true if success else false.

const ParentId& OSB_LIB::CpParent::parentId

(

)

const

Return object id of this parent connection point.

bool OSB_LIB::CpParent::release

(

OsbErrors &

errors

)

Change status from 'standby' to 'released'.

Parameters:

errors

Container for error messages if any.

Returns:

true if success else false.

const DateTime& OSB_LIB::CpParent::releaseTs

(

)

const

Return release date.

bool OSB_LIB::CpParent::revoke	(	const ConnectionPt &	cp,
		OsbErrors &	errors
	)

Change status from 'release' to 'standby'.

Parameters:

	cp	Connection point that owns this parent.
	errors	Container for error messages if any.

Returns:

true if success else false.

long OSB_LIB::CpParent::seq

(

)

const

Return the sequence number of the parent relationship.

void OSB_LIB::CpParent::setReleaseTs

(

const DateTime &

ts

)

Set release date.

Parameters:

ts

Release timestamp to set.

Exceptions:

OsbException

if the object has been released.

const CfgStatus& OSB_LIB::CpParent::status

(

)

const

Return object status.

bool OSB_LIB::CpParent::unfreeze

(

OsbErrors &

errors

)

Change status from 'standby' to 'editable'.

Parameters:

errors

Container for error messages if any.

Returns:

true if success else false.

---

Friends And Related Function Documentation

friend class ConnectionPt [friend]

Allow connection point to directly change the parent relationship to standby when revoking a connection point.

Definition at line 79 of file connectionpt.h.

friend class OSB_DB::ConnectionPtGw [friend]

Allow create function at the gateway to assign unique id to newly created parent relationship.

Definition at line 73 of file connectionpt.h.

---

Member Data Documentation

ParentId OSB_LIB::CpParent::parentId_ [private]

Object id of the parent connection point.

Definition at line 149 of file connectionpt.h.

DateTime OSB_LIB::CpParent::releaseTs_ [private]

Release date of the parent child relationship.

Definition at line 155 of file connectionpt.h.

long OSB_LIB::CpParent::seq_ [private]

Sequence of the parent relationship.

Definition at line 151 of file connectionpt.h.

CfgStatus OSB_LIB::CpParent::status_ [private]

Status of the parent child relationship.

Definition at line 153 of file connectionpt.h.

---

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

• connectionpt.h

---