comet.idtype

The comet.idtype module provides factory functions for creating CIDType objects aswell as helper functions for processing unbound ID values.

See also

Class CIDType

Instances of IDType objects

Methods

comet.idtype.create(ID1, ID2=0, ID3=0, stringID='')

Create a new CIDType object from the provided values

Parameters

  • ID1 (int) – The first int ID

  • ID2 (int) – The second int ID

  • ID3 (int) – The third int ID

  • stringID (str) – The str ID

Returns

The new ID object

Return type

CIDType

Raises

TypeError – When parameter types are invalid

Available

CScript

idtype::alloc

comet.idtype.getRecordID(stringID)

Get the RecordID part of a StringID.

Returns

StringID in the PublishingServer schema

Return type

str

Raises

  • TypeError – When parameter types are invalid

  • ValueError – When parameter stringID is empty

Available

See also

CIDType.getRecordID()

CScript

idtype::record_id

comet.idtype.getGroupID(stringID)

Get the GroupID part of a StringID.

Returns

StringID in the PublishingServer schema

Return type

str

Raises

  • TypeError – When parameter types are invalid

  • ValueError – When parameter stringID is empty

Available

See also

CIDType.getGroupID()

CScript

idtype::group_id

comet.idtype.getEntityID(stringID)

Get the EntityID part of a StringID.

Returns

StringID in the PublishingServer schema

Return type

str

Raises

  • TypeError – When parameter types are invalid

  • ValueError – When parameter stringID is empty

Available

See also

CIDType.getEntityID()

CScript

idtype::entity_id

comet.idtype.getEntityClass(stringID)

Get the EntityClass part of a StringID.

Returns

StringID in the PublishingServer schema

Return type

str

Raises

  • TypeError – When parameter types are invalid

  • ValueError – When parameter stringID is empty

Available

See also

CIDType.getEntityClass()

CScript

idtype::entity_class

comet.idtype.getParentRecordID(stringID)

Get the Parent RecordID part of a StringID.

Returns

StringID in the PublishingServer schema

Return type

str

Raises

  • TypeError – When parameter types are invalid

  • ValueError – When parameter stringID is empty

Available

See also

CIDType.getParentRecordID()

CScript

idtype::parent_record_id

comet.idtype.getParentGroupID(stringID)

Get the Parent GroupID part of a StringID.

Returns

StringID in the PublishingServer schema

Return type

str

Raises

  • TypeError – When parameter types are invalid

  • ValueError – When parameter stringID is empty

Available

See also

CIDType.getParentGroupID()

CScript

idtype::parent_group_id

comet.idtype.getParentEntityID(stringID)

Get the Parent EntityID part of a StringID.

Returns

StringID in the PublishingServer schema

Return type

str

Raises

  • TypeError – When parameter types are invalid

  • ValueError – When parameter stringID is empty

Available

See also

CIDType.getParentEntityID()

CScript

idtype::parent_entity_id

comet.idtype.getParentEntityClass(stringID)

Get the Parent EntityClass part of a StringID.

Returns

StringID in the PublishingServer schema

Return type

str

Raises

  • TypeError – When parameter types are invalid

  • ValueError – When parameter stringID is empty

Available

See also

CIDType.getParentEntityClass()

CScript

idtype::parent_entity_class