collecting_society_web.models package

Submodules

collecting_society_web.models.artist module

class collecting_society_web.models.artist.Artist

Bases: Tdb, MixinWebuser

Model wrapper for Tryton model object ‘artist’

classmethod create(vlist)

Creates artists

Parameters:

vlist (list) –

list of dicts with attributes to create artists:

[
    {
        'party': party.party (required)
        'group': bool (required)
        'name': str (required),
        'description': str,
        'picture_data': Binary,
        'picture_data_mime_type': str
    },
    {
        ...
    }
]

Raises:

KeyError – if required field is missing

Returns:

created artists None: if no object was created

Return type:

list

classmethod create_foreign(party, name, email, group=False)

Creates foreign Artist

Parameters:

• party – the Party that wants to create the foreign objects

• name – the artist name of the foreign artist object

• email – the artist email of the foreign artist object

Returns:

the artist that has been created None: if no object was created

Return type:

Artist object

classmethod delete(artist)

Deletes artist

Parameters:

artist (list) –

artists:

[artist1, artist2, ...]

Returns:

?

classmethod is_foreign_contributor(request, contribution, artist)

Checks if the artist is a foreign object and still editable by the current webuser.

Checks, if the member

1. is a foreign object

2. is still not claimed yet

3. is editable by the current web user

4. TODO: was not part of a distribution yet

Parameters:

• request (pyramid.request.Request) – Current request.

• contribution (obj) – Contribution of the artist

• artist (obj) – Artist to check.

Returns:

if member is editable. false: otherwise.

Return type:

true

classmethod is_foreign_member(request, group, member)

Checks if the member is a foreign object and still editable by the current webuser.

Checks, if the member

1. is a foreign object

2. is still not claimed yet

3. is editable by the current web user

4. TODO: was not part of a distribution yet

Parameters:

• request (pyramid.request.Request) – Current request.

• group (obj) – Group of the member in the current context

• member (obj) – Member to check.

Returns:

if member is editable. false: otherwise.

Return type:

true

classmethod is_foreign_rightsholder(request, right, artist)

Checks if the artist is a foreign object and still editable by the current webuser.

Checks, if the member

1. is a foreign object

2. is still not claimed yet

3. is editable by the current web user

4. TODO: was not part of a distribution yet

Parameters:

• request (pyramid.request.Request) – Current request.

• right (obj) – Right object.

• artist (obj) – Artist to check.

Returns:

if member is editable. false: otherwise.

Return type:

true

classmethod search(domain, offset=None, limit=None, order=None, escape=False, active=True)

Searches artists by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

list of artists

Return type:

obj

classmethod search_all(active=True)

Fetches all Artists

Returns:

artist None: if no match is found

Return type:

list

classmethod search_all_solo_artists(active=True)

Fetches all solo artists

Parameters:

active (bool) – only active artists?

Returns:

all solo artists None: if no match is found

Return type:

list

classmethod search_by_code(artist_code, active=True)

Searches an artist by artist code

Parameters:

artist_code (int) – artist.code

Returns:

artist None: if no match is found

Return type:

obj

classmethod search_by_id(artist_id, active=True)

Searches an artist by artist id

Note

We don’t want our internal ids to be exposed to the world. So better use search_by_oid().

Parameters:

artist_id (int) – artist.id

Returns:

artist None: if no match is found

Return type:

obj

classmethod search_by_name(artist_name, active=True)

Searches artists by artist name

Parameters:

artist_name (str) – artist.name

Returns:

list of artists

Return type:

obj

classmethod search_by_oid(oid, active=True)

Searches an artist by oid (public api id)

Parameters:

oid (int) – artist.oid

Returns:

artist None: if no match is found

Return type:

obj

classmethod search_by_party(party_id, active=True)

Searches artists by party id

Parameters:

party_id (int) – party.party.id

Returns:

artists of web_user None: if no match is found

Return type:

list

classmethod search_count(domain, escape=False, active=True)

Counts artists by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

number of artists

Return type:

int

classmethod search_fulltext(search_string, active=True)

Searches artists by fulltext search of - code - name - description

Parameters:

search_string (str) – string to search for

Returns:

list of artists

Return type:

obj

classmethod search_group_artists_by_party(party_id, active=True)

Searches group artists by party id

Parameters:

party_id (int) – party.party.id

Returns:

group artists of web_user None: if no match is found

Return type:

list

classmethod search_solo_artists_by_party(party_id, active=True)

Searches solo artists by party id

Parameters:

party_id (int) – party.party.id

Returns:

solo artists of web_user None: if no match is found

Return type:

list

collecting_society_web.models.artist_identifier module

class collecting_society_web.models.artist_identifier.ArtistIdentifier

Bases: Tdb

Model wrapper for Tryton model object ‘artist_identifier’

classmethod search_all()

Fetches all ArtistIdentifiers

Returns:

artist_identifiers None: if no match is found

Return type:

list

classmethod search_by_code(id_code)

Searches all foreign artist_identifiers for a given native id_code

Note

This is the preferred method of accessing an identifier. Only if id_space and id_code are both provided, an object can be determined with certainty.

Parameters:

id_code (string) – artist_identifier.id_code

Returns:

artist_identifier list None: if no match is found

Return type:

obj

classmethod search_by_id(id)

Searches a artist_identifier by id

Parameters:

id (int) – artist_identifier.id

Note

This is a search for the internal database id, not the id_code of a certaion id_space.

Returns:

artist_identifier None: if no match is found

Return type:

obj

classmethod search_by_spacecode(id_space, id_code)

Searches a artist_identifier in certain id_space by given id_code

Note

This is the preferred method of accessing an identifier. Only if id_space and id_code are bothe provided, an object can be determined with certainty.

Parameters:

• id_code (string) – artist_identifier.id_code

• id_space (string) – artist_identifier.id_space

Returns:

artist_identifier None: if no match is found

Return type:

obj

collecting_society_web.models.artist_identifier_space module

class collecting_society_web.models.artist_identifier_space.ArtistIdentifierSpace

Bases: Tdb

Model wrapper for Tryton model object ‘artist.cs_identifier_space’

classmethod search_all()

Fetches all ArtistIdentifierSpaces

Returns:

artist_identifier_spaces None: if no match is found

Return type:

list

classmethod search_by_id(id)

Searches a artist_identifier_space by id

Parameters:

id (int) – artist_identifier_space.id

Returns:

artist_identifier_space None: if no match is found

Return type:

obj

classmethod search_by_name(name)

Searches a artist_identifier_space by name

Parameters:

name (string) – artist_identifier_space.name

Returns:

artist_identifier_space None: if no match is found

Return type:

obj

collecting_society_web.models.artist_playlist module

class collecting_society_web.models.artist_playlist.ArtistPlaylist

Bases: Tdb, MixinSearchById

Model wrapper for Tryton model object ‘artist.playlist’

collecting_society_web.models.collecting_society module

class collecting_society_web.models.collecting_society.CollectingSociety

Bases: Tdb

Model wrapper for Tryton model object ‘collecting_society’

classmethod search(domain, offset=None, limit=None, order=None, escape=False, active=True)

Searches collecting societies by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

list of collecting societies

Return type:

obj

classmethod search_all()

Fetches all collecting societies

Returns:

collecting societies None: if no match is found

Return type:

list

classmethod search_by_id(collecting_society_id)

Searches a collecting society by id

Parameters:

collecting_society_id (int) – collecting_society.id

Returns:

collecting society None: if no match is found

Return type:

obj

classmethod search_by_oid(oid, active=True)

Searches a collecting society by oid (public api id)

Parameters:

oid (int) – collecting_society.oid

Returns:

collecting society None: if no match is found

Return type:

obj

collecting_society_web.models.content module

class collecting_society_web.models.content.Content

Bases: Tdb

Model wrapper for Tryton model object ‘web.user’.

classmethod create(vlist)

Creates content.

Parameters:

vlist (list) –

List of dictionaries with attributes of a content. [

{

‘active’: bool, ‘uuid’: str (required), ‘name’: str (required), ‘size’: int, ‘path’: str, ‘preview_path’: str, ‘mime_type’: str, ‘mediation’: bool, ‘duplicate_of’: int, ‘duplicates’: list, ‘entity_origin’: str (required), ‘entity_creator’: str (required), ‘user_committed_state’: bool, ‘fingerprintlogs’: list, ‘checksums’: list, ‘archive’: int, ‘category’: str (required), ‘creation’: int, ‘processing_state’: str, ‘processing_hostname’: str, ‘rejection_reason’: str, ‘length’: float, ‘channels’: int, ‘sample_rate’: int, ‘sample_width’: int

}, {

…

}

]

Returns:

List of created content. None: If no object was created.

Return type:

list (obj[content])

Raises:

KeyError – If required field is missing.

classmethod current_orphans(request, category='all')

Searches orphan content in category of current web user.

Parameters:

• request (pyramid.request.Request) – Current request.

• category (str) – optional - Category of content.

Returns:

List of content. None: If no match is found.

Return type:

list (content)

classmethod current_rejects(request, reason, category='all')

Searches rejected content (optionally in category) of current web user.

Parameters:

• request (pyramid.request.Request) – Current request.

• reason (str) – Reason for rejected content.

• category (str) – optional - Category of content.

Returns:

List of content. None: If no match is found.

Return type:

list (content)

classmethod current_uncommits(request, category='all')

Searches uncommited content (optionally in category) of current web user.

Parameters:

• request (pyramid.request.Request) – Current request.

• category (str) – optional - Category of content.

Returns:

List of content. None: If no match is found.

Return type:

list (content)

classmethod current_viewable(request)

Searches content, which the current web_user is allowed to view.

Parameters:

request (pyramid.request.Request) – Current request.

Returns:

viewable content of web_user None: if no match is found

Return type:

list

classmethod delete(content)

Deletes content

Parameters:

content (list) –

contents:

[content1, content2, ...]

Returns:

?

classmethod search(domain, offset=None, limit=None, order=None, escape=False, active=True)

Searches content entries by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

list of content entries

Return type:

obj

classmethod search_all()

Gets all content.

Returns:

List of content. None: if no match is found.

Return type:

list (obj[content])

classmethod search_by_archive(archive)

Searches a content by archive.

Parameters:

archive (int) – Id of the archive.

Returns:

List of content.

Return type:

list (content)

classmethod search_by_code(content_code, active=True)

Searches a content by content code

Parameters:

content_code (int) – content.code

Returns:

content None: if no match is found

Return type:

obj

classmethod search_by_creation(creation_id)

Searches a content by creation id.

Parameters:

creation_id (int) – Id of the creation.

Returns:

Content. None: If no match is found.

Return type:

obj (content)

classmethod search_by_creation_and_category(creation_id, category)

Searches a content by creation id and content category.

Parameters:

• creation_id (int) – Id of the creation.

• category (strint) – e.g. ‘audio’ oder ‘sheet’

Returns:

Content. None: If no match is found.

Return type:

obj (content)

classmethod search_by_extension(extension)

Searches a content by extension.

Parameters:

extension (str) – Extension of the content.

Returns:

List of content.

Return type:

list (content)

classmethod search_by_id(uid)

Searches a content by id.

Parameters:

uid (string) – Id of the content.

Returns:

Content. None: If no match is found.

Return type:

obj (content)

classmethod search_by_mime_type(mime_type)

Searches a content by mime type.

Parameters:

mime_type (str) – Mime type of the content.

Returns:

List of content.

Return type:

list (content)

classmethod search_by_name(name)

Searches a content by name.

Parameters:

name (str) – Name of the content.

Returns:

List of content.

Return type:

list (content)

classmethod search_by_oid(oid, active=True)

Searches a content by oid (public api id)

Parameters:

oid (int) – content.oid

Returns:

content None: if no match is found

Return type:

obj

classmethod search_by_party(party_id)

Searches a content by party id.

Parameters:

party_id (int) – Id of the party.

Returns:

List of content.

Return type:

list (content)

classmethod search_by_uuid(uuid)

Searches a content by uuid.

Parameters:

uuid (str) – Uuid of the content.

Returns:

Content. None: If no match is found.

Return type:

obj (content)

classmethod search_by_web_user(web_user_id)

Searches a content by web user id.

Parameters:

web_user_id (int) – Id of the user.

Returns:

List of content.

Return type:

list (content)

classmethod search_count(domain, escape=False, active=True)

Counts content entries by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

number of content entries

Return type:

int

classmethod search_orphans(party_id, category)

Searches orphan content in category of web user.

Parameters:

• cls (pyramid.request.Request) – Current request.

• party_id (int) – Res user id.

• category (str) – Category of content.

Returns:

List of content. None: If no match is found.

Return type:

list (content)

classmethod search_rejects(party_id, reason, category)

Searches duplicate content of current user.

Parameters:

• cls (pyramid.request.Request) – Current request.

• party_id (int) – Res user id.

• reason (str) – Reason for rejected content.

• category (str) – Category of content.

Returns:

List of content. None: If no match is found.

Return type:

list (content)

classmethod search_uncommits(party_id, category)

Searches uncommited content of current user.

Parameters:

• cls (pyramid.request.Request) – Current request.

• party_id (int) – Res user id.

• category (str) – Category of content.

Returns:

List of content. None: If no match is found.

Return type:

list (content)

classmethod search_unprocessed(party_id, category)

Searches unprocessed content in category of web user.

Parameters:

• cls (pyramid.request.Request) – Current request.

• party_id (int) – Res user id.

• category (str) – Category of content.

Returns:

List of content. None: If no match is found.

Return type:

list (content)

classmethod search_viewable_by_web_user(web_user_id, active=True)

Searches artists, which the web_user is allowed to view.

Parameters:

web_user_id (int) – web.user.id

Returns:

viewable artists of web_user, empty if none were found

Return type:

list

collecting_society_web.models.creation module

class collecting_society_web.models.creation.Creation

Bases: Tdb

Model wrapper for Tryton model object ‘creation’

classmethod create(vlist)

Creates creations

Parameters:

vlist (list) –

list of dicts with attributes to create creations:

[
    {
        'title': str (required)
        'artist': int artist.id (required)
        ...2DO
    },
    {
        ...
    }
]

Raises:

KeyError – if required field is missing

Returns:

created creations None: if no object was created

Return type:

list

classmethod create_foreign(party, artist_name, title)

Creates foreign Artist(!) and Creaion

Parameters:

• party – the Party that wants to create the foreign objects

• artist_name – the artist name of the foreign artist object

• title – the original title of the foreign creation object

Returns:

the creation that has been creation None: if no object was created

Return type:

Creation object

classmethod current_viewable(request)

Searches creations, which the current web_user is allowed to view.

Parameters:

request (pyramid.request.Request) – Current request.

Returns:

viewable creations of current web_user None: if no match is found

Return type:

list

classmethod delete(creation)

Deletes creation

Parameters:

creation (list) –

creations:

[creation1, creation2, ...]

Returns:

?

classmethod is_foreign_creation(web_user, creation)

Checks if the creation is a foreign object and still editable by the current webuser.

Checks, if the creation

1. is a foreign object

2. is still not claimed yet

3. is editable by the current web user

4. TODO: was not part of a distribution yet

Parameters:

• request (pyramid.request.Request) – Current request.

• release (obj) – Release of track.

• track (obj) – Track creation of release.

Returns:

if orignal is foreign and editable. false: otherwise.

Return type:

true

classmethod is_foreign_original(request, derivative, original)

Checks if the original is a foreign object and still editable by the current webuser.

Checks, if the original

1. is a foreign object

2. is still not claimed yet

3. is editable by the current web user

4. TODO: was not part of a distribution yet

Parameters:

• request (pyramid.request.Request) – Current request.

• derivative (obj) – Derived creation.

• original (obj) – Original creation.

Returns:

if orignal is foreign and editable. false: otherwise.

Return type:

true

classmethod is_foreign_track(web_user, release, creation)

Checks if the track is a foreign object and still editable by the current webuser.

Checks, if the creation

1. is a foreign object

2. is still not claimed yet

3. is editable by the current web user

4. TODO: was not part of a distribution yet

Parameters:

• request (pyramid.request.Request) – Current request.

• release (obj) – Release of track.

• creation (obj) – Track creation of release.

Returns:

if orignal is foreign and editable. false: otherwise.

Return type:

true

classmethod search(domain, offset=None, limit=None, order=None, escape=False, active=True)

Searches creations by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

list of creations

Return type:

obj

classmethod search_all(active=True)

Fetches all Creations

Parameters:

active (bool, optional) – active records only? Defaults to True.

Returns:

creation None: if no match is found

Return type:

list

classmethod search_by_artist(artist_id, active=True)

Searches creations by artist id

Parameters:

• artist_id (int) – artist.id

• active (bool, optional) – active records only? Defaults to True.

Returns:

creations None: if no match is found

Return type:

list

classmethod search_by_artistname_and_title(artist_name, title, active=True)

Searches creations by artist name and title

Parameters:

• artist_name (char) – artist.name

• title (char) – creation.title

• active (bool, optional) – active records only? Defaults to True.

Returns:

creations None: if no match is found

Return type:

list

classmethod search_by_code(creation_code, active=True)

Searches a creation by artist code

Parameters:

creation_code (int) – creation.code

Returns:

creation None: if no match is found

Return type:

obj

classmethod search_by_contributions_of_artist(artist_id, active=True)

Searches creations by contributions of artist id

Parameters:

• artist_id (int) – artist.id

• active (bool, optional) – active records only? Defaults to True.

Returns:

creations None: if no match is found

Return type:

list

classmethod search_by_id(creation_id, active=True)

Searches a creation by creation id

Note

We don’t want our internal ids to be exposed to the world. So better use search_by_oid().

Parameters:

• creation_id (int) – creation.id

• active (bool, optional) – active records only? Defaults to True.

Returns:

creation None: if no match is found

Return type:

obj

classmethod search_by_oid(oid, active=True)

Searches a creation by oid (public api id)

Parameters:

oid (uuid) – creation.oid

Returns:

creation None: if no match is found

Return type:

obj

classmethod search_by_party(party_id, active=True)

Searches creations by party id

Parameters:

• party_id (int) – party.party.id

• active (bool, optional) – active records only? Defaults to True.

Returns:

creations of web_user None: if no match is found

Return type:

list

classmethod search_count(domain, escape=False, active=True)

Counts creations by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

number of creations

Return type:

int

classmethod search_viewable_by_web_user(web_user_id, active=True)

Searches creations, which the web_user is allowed to view.

Parameters:

web_user_id (int) – web.user.id

Returns:

viewable creations of web_user, empty if none were found

Return type:

list

collecting_society_web.models.creation_contribution module

class collecting_society_web.models.creation_contribution.CreationContribution

Bases: Tdb

Model wrapper for Tryton model object ‘creation.contribution’

classmethod create(vlist)

Creates creation contributions

Parameters:

vlist (list) – list of dicts with attributes to create

Raises:

KeyError – if required field is missing

Returns:

created creation contributions None: if no object was created

Return type:

list

classmethod delete(contributions)

Deletes creation contribution

Parameters:

contributions (list) – creation.contribution

Returns:

?

classmethod search_all()

Fetches all creation contributions

Returns:

creation.contribution None: if no match is found

Return type:

list

classmethod search_by_id(contribution_id)

Searches a creation contribution by id

Parameters:

contribution_id (int) – contribution.id

Returns:

creation.contribution None: if no match is found

Return type:

obj

classmethod search_by_oid(oid)

Searches a creation contribution by oid (public api id)

Parameters:

oid (int) – creation.contribution.oid

Returns:

creation.contribution None: if no match is found

Return type:

obj

collecting_society_web.models.creation_derivative module

class collecting_society_web.models.creation_derivative.CreationDerivative

Bases: Tdb

Model wrapper for Tryton model object ‘creation_derivative’

classmethod create(vlist)

Creates origina-derivative relations

Parameters:

• vlist (list) – list of dicts with attributes

• relations:: (to create origina-derivative) –

  [

  {

  ‘original_creation’: creation.id, ‘derivative_creation’: creation.id, ‘allocation_type’: ‘adaption’|’cover’|’remix’

  }, {

  …

  }

  ]

Raises:

KeyError – if required field is missing

Returns:

created origina-derivative relations None: if no object was created

Return type:

list

classmethod delete(creation)

Deletes creation(s)

Parameters:

creation (list) –

creations:

[creation1, creation2, ...]

Returns:

?

classmethod search_by_oid(oid)

Searches for a CreationDerivative object by its oid

Parameters:

oid (string) – a uuid formed string

Returns:

CreationDerivative object None: if no match is found

Return type:

obj

classmethod search_original_derivative_pair(derivative_oid, original_oid)

Searches for certain derivative/original combinations

Parameters:

• derivative_oid (string)

• original_oid (string) – a uuid formed string

Returns:

list of creations None: if no match is found

Return type:

obj

classmethod search_originals_of_creation_by_id(creation_id)

Searches all original creations of a creation by its id

Parameters:

creation_id (int) – creation.id

Returns:

list of creations None: if no match is found

Return type:

obj

collecting_society_web.models.creation_identifier module

class collecting_society_web.models.creation_identifier.CreationIdentifier

Bases: Tdb

Model wrapper for Tryton model object ‘creation_identifier’

classmethod search_all()

Fetches all CreationIdentifiers

Returns:

creation_identifiers None: if no match is found

Return type:

list

classmethod search_by_code(id_code)

Searches all foreign creation_identifiers for a given native id_code

Note

This is the preferred method of accessing an identifier. Only if id_space and id_code are both provided, an object can be determined with certainty.

Parameters:

id_code (string) – creation_identifier.id_code

Returns:

creation_identifier list None: if no match is found

Return type:

obj

classmethod search_by_id(id)

Searches a creation_identifier by id

Parameters:

id (int) – creation_identifier.id

Note

This is a search for the internal database id, not the id_code of a certaion id_space.

Returns:

creation_identifier None: if no match is found

Return type:

obj

classmethod search_by_spacecode(id_space, id_code)

Searches a creation_identifier in certain id_space by given id_code

Note

This is the preferred method of accessing an identifier. Only if id_space and id_code are bothe provided, an object can be determined with certainty.

Parameters:

• id_code (string) – creation_identifier.id_code

• id_space (string) – creation_identifier.id_space

Returns:

creation_identifier None: if no match is found

Return type:

obj

collecting_society_web.models.creation_identifier_space module

class collecting_society_web.models.creation_identifier_space.CreationIdentifierSpace

Bases: Tdb

Model wrapper for Tryton model object ‘creation_identifier_space’

classmethod search_all()

Fetches all CreationIdentifierSpaces

Returns:

creation_identifier_spaces None: if no match is found

Return type:

list

classmethod search_by_id(id)

Searches a creation_identifier_space by id

Parameters:

id (int) – creation_identifier_space.id

Returns:

creation_identifier_space None: if no match is found

Return type:

obj

classmethod search_by_name(name)

Searches a creation_identifier_space by name

Parameters:

name (string) – creation_identifier_space.name

Returns:

creation_identifier_space None: if no match is found

Return type:

obj

collecting_society_web.models.creation_right module

class collecting_society_web.models.creation_right.CreationRight

Bases: Tdb

Model wrapper for Tryton model object ‘creation.right’

classmethod create(vlist)

Creates creation.right relations

Parameters:

• vlist (list) – list of dicts with attributes

• relations:: (to create creation.right) –

  [

  {

  ‘rightsholder’: right_subject.id, ‘rightsobject’: creation.id, ‘type_of_right’: “copyright”, ‘contribution’: “production”, ‘instruments’: instruments_dict,

  }, {

  …

  }

  ]

Raises:

KeyError – if required field is missing

Returns:

created creation.right relations None: if no object was created

Return type:

list

classmethod delete(cr)

Deletes creation.right relations

Parameters:

cr (list) –

creation.right relations:

[creation right 1, creation.right 2, ...]

Returns:

?

classmethod get_contributions_by_type_of_right(t_o_r)

classmethod search(domain, offset=None, limit=None, order=None, escape=False)

Searches creation rights by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

list of creation rights

Return type:

obj

classmethod search_count(domain, escape=False, active=True)

Counts creation rights by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

number of creation rights

Return type:

int

collecting_society_web.models.creation_right_instrument module

class collecting_society_web.models.creation_right_instrument.CreationRightInstrument

Bases: Tdb

Model wrapper for Tryton model object ‘creation.right’

classmethod search_by_right_and_instrument(right_id, instrument_id)

Searches creation.right-instrument

Parameters:

• right_id (int) – creation-right.id

• instrument_id (int) – instrument.id

Returns:

creations.right None: if no match is found

Return type:

list

collecting_society_web.models.creation_role module

class collecting_society_web.models.creation_role.CreationRole

Bases: Tdb

Model wrapper for Tryton model object ‘creation.role’

classmethod search_all()

Fetches all creation roles

Returns:

creation roles None: if no match is found

Return type:

list

classmethod search_by_id(id)

Searches a creation role by id

Parameters:

id (int) – creation.role.id

Returns:

creation role None: if no match is found

Return type:

obj

classmethod search_by_name(name)

Searches a creation role by name

Parameters:

name (string) – creation.role

Returns:

creation role None: if no match is found

Return type:

obj

classmethod search_by_oid(oid)

Searches an creation role by oid (public api id)

Parameters:

oid (int) – creation.role.oid

Returns:

creation role None: if no match is found

Return type:

obj

collecting_society_web.models.creation_tariff_category module

class collecting_society_web.models.creation_tariff_category.CreationTariffCategory

Bases: Tdb

Model wrapper for Tryton model object ‘creation-tariff_category’

classmethod create(vlist)

Creates creation tariff categories

Parameters:

vlist (list) – list of dicts with attributes to create objects

Raises:

KeyError – if required field is missing

Returns:

created creation tariff categories None: if no object was created

Return type:

list

classmethod delete(ctcs)

Deletes creation tariff categories

Parameters:

ctcs (list) –

creation tariff categories:

[creation_tariff_category, creation_tariff_category, ...]

Returns:

?

classmethod search(domain, offset=None, limit=None, order=None, escape=False)

Searches creation tariff categories by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

list of creation tariff categories

Return type:

obj

classmethod search_all()

Fetches all creation tariff categories

Returns:

creation tariff categories None: if no match is found

Return type:

list

classmethod search_by_id(ctc_id)

Searches a creation tariff category by creation tariff category id

Parameters:

ctc_id (int) – creation_tariff_category.id

Returns:

creation tariff category None: if no match is found

Return type:

obj

classmethod search_by_oid(oid)

Searches a creation tariff category by oid (public api id)

Parameters:

oid (int) – creation_tariff_category.oid

Returns:

creation tariff category None: if no match is found

Return type:

obj

collecting_society_web.models.declaration module

class collecting_society_web.models.declaration.Declaration

Bases: Tdb, MixinSearchById

Model wrapper for Tryton model object ‘declaration’

classmethod belongs_to_current_licensee(request)

returns all objects that belong to a certain licensee

Parameters:

request (pyramid.request.Request) – Current request.

Returns:

objects that belong to the licensee None: if no match is found

Return type:

list

collecting_society_web.models.declaration_group module

class collecting_society_web.models.declaration_group.DeclarationGroup

Bases: Tdb, MixinSearchById, MixinSearchByName

Model wrapper for Tryton model object ‘declaration.group’

collecting_society_web.models.device module

class collecting_society_web.models.device.Device

Bases: Tdb

Model wrapper for Tryton model object ‘device’

classmethod belongs_to_current_webuser(request)

returns all objects that belong to a certain licensee

Parameters:

request (pyramid.request.Request) – Current request.

Returns:

objects that belong to the licensee None: if no match is found

Return type:

list

classmethod create(vlist)

Creates devices

Parameters:

vlist (list) –

list of dicts with attributes to create devices:

[
    {
        'web_user': ...,
        'uuid': ...,
        'name': ...,
        'os_name': ...,
        'os_version': ...,
        'software_name': ...,
        'software_version': ...,
        'software_vendor': ...
    },
    {
        ...
    }
]

Raises:

KeyError – if required field is missing

Returns:

created devices None: if no object was created

Return type:

list

classmethod delete(device)

Deletes device

Parameters:

device (list) –

devices:

[device1, device2, ...]

Returns:

?

classmethod search(domain, offset=None, limit=None, order=None, escape=False, active=True)

Searches devices by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

list of devices

Return type:

obj

classmethod search_all(active=True)

Fetches all Devices

Returns:

device None: if no match is found

Return type:

list

classmethod search_by_id(device_id, active=True)

Searches an device by device id

Parameters:

device_id (int) – device.id

Returns:

device None: if no match is found

Return type:

obj

classmethod search_by_name(device_name, active=True)

Searches devices by device name

Parameters:

device_name (str) – device.name

Returns:

list of devices

Return type:

obj

classmethod search_by_uuid(device_uuid, active=True)

Searches an device by device uuid

Parameters:

device_uuid (string) – device.uuid

Returns:

device None: if no match is found

Return type:

obj

classmethod search_count(domain, escape=False, active=True)

Counts devices by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

number of devices

Return type:

int

collecting_society_web.models.device_message module

class collecting_society_web.models.device_message.DeviceMessage

Bases: Tdb, MixinSearchById, MixinSearchByUuid

Model wrapper for Tryton model object ‘device.message’

collecting_society_web.models.device_message_fingerprint_creationlist module

class collecting_society_web.models.device_message_fingerprint_creationlist.DeviceMessageFingerprintCreationlist

Bases: Tdb, MixinSearchById

Model wrapper for Tryton model object ‘device.message.fingerprint.creationlist’

collecting_society_web.models.event module

class collecting_society_web.models.event.Event

Bases: Tdb, MixinSearchById

Model wrapper for Tryton model object ‘event’

collecting_society_web.models.event_performance module

class collecting_society_web.models.event_performance.EventPerformance

Bases: Tdb, MixinSearchById

Model wrapper for Tryton model object ‘event.performance’

collecting_society_web.models.genre module

class collecting_society_web.models.genre.Genre

Bases: Tdb

Model wrapper for Tryton model object ‘genre’

classmethod search_all()

Fetches all Genres

Returns:

genres None: if no match is found

Return type:

list

classmethod search_by_id(id)

Searches a genre by id

Parameters:

id (int) – genre.id

Returns:

genre None: if no match is found

Return type:

obj

classmethod search_by_name(name)

Searches a genre by name

Parameters:

name (string) – genre.name

Returns:

genre None: if no match is found

Return type:

obj

classmethod search_by_oid(oid, active=True)

Searches an genre by oid (public api id)

Parameters:

oid (int) – genre.oid

Returns:

genre None: if no match is found

Return type:

obj

collecting_society_web.models.instrument module

class collecting_society_web.models.instrument.Instrument

Bases: Tdb, MixinSearchById, MixinSearchByOid, MixinSearchAll

Model wrapper for Tryton model object ‘instrument’

collecting_society_web.models.label module

class collecting_society_web.models.label.Label

Bases: Tdb

Model wrapper for Tryton model object ‘label’

classmethod create(vlist)

Creates labels

Parameters:

vlist (list) –

list of dicts with attributes to create label:

[
    {
        'name': str (required)
    },
    {
        ...
    }
]

Raises:

KeyError – if required field is missing

Returns:

created labels None: if no object was created

Return type:

list

classmethod search(domain, offset=None, limit=None, order=None, escape=False)

Searches labels by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

list of labels

Return type:

obj

classmethod search_all()

Fetches all Labels

Returns:

labels None: if no match is found

Return type:

list

classmethod search_by_gvl_code(gvl_code)

Searches a label by gvl code

Parameters:

gvl_code (string) – label.gvl_code

Returns:

label None: if no match is found

Return type:

obj

classmethod search_by_name_starting_with(name_starting_with)

Searches a label for a name starting with certaion characters

Parameters:

name_starting_with (string) – label.name

Returns:

label None: if no match is found

Return type:

obj

classmethod search_by_oid(oid, active=True)

Searches a label by oid (public api id)

Parameters:

oid (int) – label.oid

Returns:

label None: if no match is found

Return type:

obj

classmethod search_count(domain, escape=False, active=True)

Counts labels by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

number of labels

Return type:

int

collecting_society_web.models.license module

class collecting_society_web.models.license.License

Bases: Tdb

Model wrapper for Tryton model object ‘license’

classmethod search_all()

Fetches all Licenses

Returns:

licenses None: if no match is found

Return type:

list

classmethod search_by_id(license_id)

Searches an license by license id

Parameters:

license_id (int) – license.id

Returns:

license None: if no match is found

Return type:

obj

classmethod search_by_oid(oid, active=True)

Searches a license by oid (public api id)

Parameters:

oid (int) – license.oid

Returns:

license None: if no match is found

Return type:

obj

collecting_society_web.models.location module

class collecting_society_web.models.location.Location

Bases: Tdb, MixinSearchById, MixinSearchByOid, MixinSearchAll

Model wrapper for Tryton model object ‘location’

classmethod create(vlist)

Creates location

Parameters:

vlist (list) –

list of dicts with attributes to create publisher:

[
    {
        'name': str (required)
        'entity_creator': int (required)
    },
    {
        ...
    }
]

Raises:

KeyError – if required field is missing

Returns:

created location None: if no object was created

Return type:

list

classmethod delete(location)

Deletes location

Parameters:

location (list) –

locations:

[location1, location2, ...]

Returns:

?

classmethod search_by_entity_creator(party_id, active=True)

Searches locations, the web_user is allowed to view.

Parameters:

web_user_id (int) – web.user.id

Returns:

viewable creations of web_user, empty if none were found

Return type:

list

collecting_society_web.models.location_category module

class collecting_society_web.models.location_category.LocationCategory

Bases: Tdb, MixinSearchById, MixinSearchByCode, MixinSearchByName, MixinSearchAll

Model wrapper for Tryton model object ‘location.category’

collecting_society_web.models.location_indicators_period module

class collecting_society_web.models.location_indicators_period.LocationIndicatorsPeriod

Bases: Tdb, MixinSearchById

Model wrapper for Tryton model object ‘location.indicators.period’

collecting_society_web.models.location_space module

class collecting_society_web.models.location_space.LocationSpace

Bases: Tdb, MixinSearchById, MixinSearchByOid, MixinSearchAll

Model wrapper for Tryton model object ‘location.space’

classmethod search_count(domain, escape=False, active=True)

Counts location spaces by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

number of location spaces

Return type:

int

collecting_society_web.models.location_space_category module

class collecting_society_web.models.location_space_category.LocationSpaceCategory

Bases: Tdb, MixinSearchById, MixinSearchByCode, MixinSearchByName, MixinSearchAll

Model wrapper for Tryton model object ‘location.space.category’

collecting_society_web.models.publisher module

class collecting_society_web.models.publisher.Publisher

Bases: Tdb

Model wrapper for Tryton model object ‘publisher’

classmethod create(vlist)

Creates publisher

Parameters:

vlist (list) –

list of dicts with attributes to create publisher:

[
    {
        'name': str (required)
    },
    {
        ...
    }
]

Raises:

KeyError – if required field is missing

Returns:

created publisher None: if no object was created

Return type:

list

classmethod search(domain, offset=None, limit=None, order=None, escape=False)

Searches publisher by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

list of publisher

Return type:

obj

classmethod search_all()

Fetches all Labels

Returns:

publisher None: if no match is found

Return type:

list

classmethod search_by_oid(oid, active=True)

Searches a label by oid (public api id)

Parameters:

oid (int) – label.oid

Returns:

label None: if no match is found

Return type:

obj

classmethod search_count(domain, escape=False, active=True)

Counts publisher by domain

Parameters:

domain (list) – domain passed to tryton

Returns:

number of publisher

Return type:

int

collecting_society_web.models.release module

class collecting_society_web.models.release.Release

Bases: Tdb

Model wrapper for Tryton model object ‘release’

classmethod create(vlist)

Creates Releases

Parameters:

vlist (list) –

list of dicts with attributes to create releases:

[
    {
        ...2DO
    },
    {
        ...
    }
]

Raises:

KeyError – if required field is missing

Returns:

created releases None: if no object was created

Return type:

list

classmethod current_editable(request)

Searches releases, which the current web user is allowed to edit.

Parameters:

request (pyramid.request.Request) – Current request.

Returns:

editable releases of current web_user None: if no match is found

Return type:

list

classmethod current_viewable(request)

Searches releases, which the current web user is allowed to view.

Parameters:

request (pyramid.request.Request) – Current request.

Returns:

viewable releases of current web_user None: if no match is found

Return type:

list

classmethod delete(release)

Deletes release

Parameters:

release (list) –

realeases:

[release1, release2, ...]

Returns:

?

classmethod search_all(active=True)

Fetches all Releases

Parameters:

active (bool, optional) – active records only? Defaults to True.

Returns:

releases None: if no match is found

Return type:

list

classmethod search_by_code(release_code, active=True)

Searches an release by release code

Parameters:

release_code (string) – release.code

Returns:

release None: if no match is found

Return type:

obj

classmethod search_by_id(uid, active=True)

Searches releases by id

Note

We don’t want our internal ids to be exposed to the world. So better use search_by_oid().

Parameters:

uid (int) – release id

Returns:

releases of web_user None: if no match is found

Return type:

list

classmethod search_by_oid(oid, active=True)

Searches a release by oid (public api id)

Parameters:

oid (int) – release.oid

Returns:

release None: if no match is found

Return type:

obj

classmethod search_by_party(party_id, active=True)

Searches releases by party id

Parameters:

party_id (int) – party.party.id

Returns:

releases of web_user

and of releases the web user has creations on

None: if no match is found

Return type:

list

classmethod search_editable_by_web_user(web_user_id, active=True)

Searches releases, which the web_user is allowed to edit.

Parameters:

web_user_id (int) – web.user.id

Returns:

editable releases of web_user, empty if none were found

Return type:

list

classmethod search_viewable_by_web_user(web_user_id, active=True)

Searches releases, which the web_user is allowed to view.

Parameters:

web_user_id (int) – web.user.id

Returns:

viewable releases of web_user, empty if none were found

Return type:

list

collecting_society_web.models.release_identifier module

class collecting_society_web.models.release_identifier.ReleaseIdentifier

Bases: Tdb

Model wrapper for Tryton model object ‘release_identifier’

classmethod search_all()

Fetches all ReleaseIdentifiers

Returns:

release_identifiers None: if no match is found

Return type:

list

classmethod search_by_code(id_code)

Searches all foreign release_identifiers for a given native id_code

Note

This is the preferred method of accessing an identifier. Only if id_space and id_code are both provided, an object can be determined with certainty.

Parameters:

id_code (string) – release_identifier.id_code

Returns:

release_identifier list None: if no match is found

Return type:

obj

classmethod search_by_id(id)

Searches a release_identifier by id

Parameters:

id (int) – release_identifier.id

Note

This is a search for the internal database id, not the id_code of a certaion id_space.

Returns:

release_identifier None: if no match is found

Return type:

obj

classmethod search_by_spacecode(id_space, id_code)

Searches a release_identifier in certain id_space by given id_code

Note

This is the preferred method of accessing an identifier. Only if id_space and id_code are bothe provided, an object can be determined with certainty.

Parameters:

• id_code (string) – release_identifier.id_code

• id_space (string) – release_identifier.id_space

Returns:

release_identifier None: if no match is found

Return type:

obj

collecting_society_web.models.release_identifier_space module

class collecting_society_web.models.release_identifier_space.ReleaseIdentifierSpace

Bases: Tdb

Model wrapper for Tryton model object ‘release_identifier_space’

classmethod search_all()

Fetches all ReleaseIdentifierSpaces

Returns:

release_identifier_spaces None: if no match is found

Return type:

list

classmethod search_by_id(id)

Searches a release_identifier_space by id

Parameters:

id (int) – release_identifier_space.id

Returns:

release_identifier_space None: if no match is found

Return type:

obj

classmethod search_by_name(name)

Searches a release_identifier_space by name

Parameters:

name (string) – release_identifier_space.name

Returns:

release_identifier_space None: if no match is found

Return type:

obj

collecting_society_web.models.style module

class collecting_society_web.models.style.Style

Bases: Tdb

Model wrapper for Tryton model object ‘style’

classmethod search_all()

Fetches all Styles

Returns:

styles None: if no match is found

Return type:

list

classmethod search_by_id(id)

Searches a style by id

Parameters:

id (int) – style.id

Returns:

style None: if no match is found

Return type:

obj

classmethod search_by_name(name)

Searches a style by name

Parameters:

name (string) – style.name

Returns:

style None: if no match is found

Return type:

obj

classmethod search_by_oid(oid, active=True)

Searches a style by oid (public api id)

Parameters:

oid (int) – style.oid

Returns:

style None: if no match is found

Return type:

obj

collecting_society_web.models.tariff_category module

class collecting_society_web.models.tariff_category.TariffCategory

Bases: Tdb

Model wrapper for Tryton model object ‘tariff_system.category’

classmethod search_all()

Fetches all tariff categories

Returns:

tariff categories None: if no match is found

Return type:

list

classmethod search_by_id(category_id)

Searches a tariff category by id

Parameters:

category_id (int) – tariff_category.id

Returns:

tariff category None: if no match is found

Return type:

obj

classmethod search_by_oid(oid, active=True)

Searches a tariff category by oid (public api id)

Parameters:

oid (int) – tariff_category.oid

Returns:

tariff category None: if no match is found

Return type:

obj

collecting_society_web.models.track module

class collecting_society_web.models.track.Track

Bases: Tdb

Model wrapper for Tryton model object ‘artist’

classmethod create(vlist)

Creates tracks

Parameters:

vlist (list) – list of dicts with attributes to create tracks

Raises:

KeyError – if required field is missing

Returns:

created tracks None: if no object was created

Return type:

list

classmethod delete(tracks)

Deletes track

Parameters:

tracks (list) –

tracks:

[artist1, artist2, ...]

Returns:

?

classmethod search_all()

Fetches all Tracks

Returns:

tracks None: if no match is found

Return type:

list

classmethod search_by_id(track_id)

Searches a track by track id

Parameters:

track_id (int) – track.id

Returns:

track None: if no match is found

Return type:

obj

classmethod search_by_oid(oid)

Searches a track by oid (public api id)

Parameters:

oid (int) – track.oid

Returns:

track None: if no match is found

Return type:

obj

collecting_society_web.models.utilisation module

class collecting_society_web.models.utilisation.Utilisation

Bases: Tdb, MixinSearchById

Model wrapper for Tryton model object ‘utilisation’

collecting_society_web.models.website module

class collecting_society_web.models.website.Website

Bases: Tdb, MixinSearchById

Model wrapper for Tryton model object ‘website’

collecting_society_web.models.website_resource module

class collecting_society_web.models.website_resource.WebsiteResource

Bases: Tdb, MixinSearchById, MixinSearchByName, MixinSearchByUuid

Model wrapper for Tryton model object ‘website.resource’

collecting_society_web.models.website_resource_category module

class collecting_society_web.models.website_resource_category.WebsiteResourceCategory

Bases: Tdb, MixinSearchById, MixinSearchByName, MixinSearchByCode

Model wrapper for Tryton model object ‘website.resource.category’

Module contents