comet.CIDType

class comet.CIDType

A CIDType object is an object comprised of three int values and a str value forming the so called RecordID.

Several other helper functions are provided for extracting data from the str part of the ID when connected to a priint:suite publishing server.

See also

Module idtype

Factory functions for CIDType objects and helpers for extracting values.

Methods

CIDType.getID() → int

Get the first number of this ID

Returns:

First number ID

Return type:

int

Available:

InDesign® comet_pdf® Illustrator®

CScript:

idtype::id

CIDType.getID2() → int

Get the second number of this ID

Returns:

Second number ID

Return type:

int

Available:

InDesign® comet_pdf® Illustrator®

CScript:

idtype::id2

CIDType.getID3() → int

Get the third number of this ID

Returns:

Third number ID

Return type:

int

Available:

InDesign® comet_pdf® Illustrator®

CScript:

idtype::id3

CIDType.getStringID() → str

Get the string ID of this ID

Returns:

The string ID

Return type:

str

Available:

InDesign® comet_pdf® Illustrator®

CScript:

idtype::stringid

CIDType.getValues() → tuple[int, int, int, str]

This is a convenience function for returning all four ID values

Returns:

The ID as (id1, id2, id3, stringID)

Return type:

tuple[int, int, int, str]

Available:

InDesign® comet_pdf® Illustrator®

CScript:

• idtype::id

• idtype::id2

• idtype::id3

• idtype::stringid

CIDType.setID(ID: int) → None

Set the first number of this ID

Parameters:

ID (int) – The value to set

Return type:

None

Available:

InDesign® comet_pdf® Illustrator®

CScript:

idtype::set_id

CIDType.setID2(ID: int) → None

Set the second number of this ID

Parameters:

ID (int) – The value to set

Return type:

None

Available:

InDesign® comet_pdf® Illustrator®

CScript:

idtype::set_id2

CIDType.setID3(ID: int) → None

Set the third number of this ID

Parameters:

ID (int) – The value to set

Return type:

None

Available:

InDesign® comet_pdf® Illustrator®

CScript:

idtype::set_id3

CIDType.setStringID(ID: str) → None

Set the string ID of this ID

Parameters:

ID (str) – The value to set

Return type:

None

Available:

InDesign® comet_pdf® Illustrator®

CScript:

idtype::set_stringid

CIDType.setValues(values: tuple[int, int, int, str]) → None

This is a convenience function for setting all four ID values

Parameters:

values (tuple[int, int, int, str]) – The values to set.

Return type:

None

Raises:

TypeError – When parameter types are invalid

Available:

InDesign® comet_pdf® Illustrator®

CScript:

• idtype::set_id

• idtype::set_id2

• idtype::set_id3

• idtype::set_stringid

CIDType.getRecordID() → str

Get the RecordID part of a StringID.

Returns:

Record ID part of the string ID

Return type:

str

Available:

InDesign® comet_pdf® Illustrator®

See also:

idtype.getRecordID()

CScript:

idtype::record_id

CIDType.getGroupID() → str

Get the GroupID part of a StringID.

Returns:

Group ID part of the string ID

Return type:

str

Available:

InDesign® comet_pdf® Illustrator®

See also:

idtype.getGroupID()

CScript:

idtype::group_id

CIDType.getEntityID() → str

Get the EntityID part of a StringID.

Returns:

StringID in the PublishingServer schema

Return type:

str

Available:

InDesign® comet_pdf® Illustrator®

See also:

idtype.getEntityID()

CScript:

idtype::entity_id

CIDType.getEntityClass() → str

Get the EntityClass part of a StringID.

Returns:

Entity class part of the string ID

Return type:

str

Available:

InDesign® comet_pdf® Illustrator®

See also:

idtype.getEntityClass()

CScript:

idtype::entity_class

CIDType.getParentRecordID() → str

Get the Parent RecordID part of a StringID.

Returns:

Parent record ID part of the string ID

Return type:

str

Available:

InDesign® comet_pdf® Illustrator®

See also:

idtype.getParentRecordID()

CScript:

idtype::parent_record_id

CIDType.getParentGroupID() → str

Get the Parent GroupID part of a StringID.

Returns:

Parent group ID part of the string ID

Return type:

str

Available:

InDesign® comet_pdf® Illustrator®

See also:

idtype.getParentGroupID()

CScript:

idtype::parent_group_id

CIDType.getParentEntityID() → str

Get the Parent EntityID part of a StringID.

Returns:

Parent entity ID part of the string ID

Return type:

str

Available:

InDesign® comet_pdf® Illustrator®

See also:

idtype.getParentEntityID()

CScript:

idtype::parent_entity_id

CIDType.getParentEntityClass() → str

Get the Parent EntityClass part of a StringID.

Returns:

Parent entity class part of the string ID

Return type:

str

Available:

InDesign® comet_pdf® Illustrator®

See also:

idtype.getParentEntityClass()

CScript:

idtype::parent_entity_class

Special methods

CIDType.__repr__() → str

String representation.

Returns:

<CIDType> ID1: ID1 | ID2: ID2 | ID3: ID3 | StringID: ‘StringID’

Example

<CIDType> ID1: 1 | ID2: 2 | ID3: 3 | StringID: ABCD

Return type:

str