Package trac :: Package ticket :: Module api :: Class TicketSystem

Class TicketSystem

    object --+    
             |    
core.Component --+
                 |
                TicketSystem

Nested Classes
Inherited from `core.Component`: `__metaclass__`

Instance Methods

ticket_custom_section(...)
In this section, you can define additional fields for tickets.

source code

__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

get_available_actions(self, req, ticket)
Returns a sorted list of available actions

source code

get_all_status(self)
Returns a sorted list of all the states all of the action controllers know about.

source code

get_ticket_field_labels(self)
Produce a (name,label) mapping from get_ticket_fields.

source code

get_ticket_fields(self)
Returns list of fields available for tickets.

source code

reset_ticket_fields(self)
Invalidate ticket field cache.

source code

get_custom_fields(self)

source code

get_field_synonyms(self)
Return a mapping from field name synonyms to field names.

source code

eventually_restrict_owner(self, field, ticket=None)
Restrict given owner field to be a list of users having the TICKET_MODIFY permission (for the given ticket)

source code

get_allowed_owners(self, ticket=None)
Returns a list of permitted ticket owners (those possessing the TICKET_MODIFY permission).

source code

prepare_ticket(self, req, ticket, fields, actions)

source code

validate_ticket(self, req, ticket)

source code

validate_comment(self, req, comment)

source code

get_permission_actions(self)

source code

get_link_resolvers(self)

source code

get_wiki_syntax(self)

source code

get_resource_realms(self)

source code

get_resource_description(self, resource, format=None, context=None, **kwargs)

source code

format_summary(self, summary, status=None, resolution=None, type=None)

source code

resource_exists(self, resource)

source code

Inherited from core.Component: __repr__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods
Inherited from `core.Component`: `implements`

Class Variables
	realm = `'ticket'`
	action_controllers = `<OrderedExtensionsOption [ticket] 'workfl...`
	restrict_owner = `<BoolOption [ticket] 'restrict_owner'>`
	default_version = `<Option [ticket] 'default_version'>`
	default_type = `<Option [ticket] 'default_type'>`
	default_priority = `<Option [ticket] 'default_priority'>`
	default_milestone = `<Option [ticket] 'default_milestone'>`
	default_component = `<Option [ticket] 'default_component'>`
	default_severity = `<Option [ticket] 'default_severity'>`
	default_summary = `<Option [ticket] 'default_summary'>`
	default_description = `<Option [ticket] 'default_description'>`
	default_keywords = `<Option [ticket] 'default_keywords'>`
	default_owner = `<Option [ticket] 'default_owner'>`
	default_cc = `<Option [ticket] 'default_cc'>`
	default_resolution = `<Option [ticket] 'default_resolution'>`
	allowed_empty_fields = `<ListOption [ticket] 'allowed_empty_fie...`
	max_comment_size = `<IntOption [ticket] 'max_comment_size'>`
	max_description_size = `<IntOption [ticket] 'max_description_si...`
	max_summary_size = `<IntOption [ticket] 'max_summary_size'>`
	reserved_field_names = `['report', 'order', 'desc', 'group', 'g...`

Properties
	change_listeners List of components that implement `~trac.ticket.api.ITicketChangeListener`
	milestone_change_listeners List of components that implement `~trac.ticket.api.IMilestoneChangeListener`
	fields Return the list of fields available for tickets.
	custom_fields Return the list of custom ticket fields available for tickets.
Inherited from `object`: `__class__`

Method Details

ticket_custom_section(...)

source code

In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.

init(self)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

get_ticket_fields(self)

source code

Returns list of fields available for tickets.

Each field is a dict with at least the 'name', 'label' (localized) and 'type' keys. It may in addition contain the 'custom' key, the 'optional' and the 'options' keys. When present 'custom' and 'optional' are always True.

get_field_synonyms(self)

source code

Return a mapping from field name synonyms to field names. The synonyms are supposed to be more intuitive for custom queries.

get_allowed_owners(self, ticket=None)

source code

Returns a list of permitted ticket owners (those possessing the TICKET_MODIFY permission). Returns None if the option [ticket] restrict_owner is False.

If ticket is not None, fine-grained permission checks are used to determine the allowed owners for the specified resource.

Since: 1.0.3

Class Variable Details

action_controllers

Value:

<OrderedExtensionsOption [ticket] 'workflow'>

allowed_empty_fields

Value:

<ListOption [ticket] 'allowed_empty_fields'>

max_description_size

Value:

<IntOption [ticket] 'max_description_size'>

reserved_field_names

Value:

['report',
 'order',
 'desc',
 'group',
 'groupdesc',
 'col',
 'row',
 'format',
...

Property Details

change_listeners

List of components that implement ~trac.ticket.api.ITicketChangeListener

Get Method:: unreachable.extensions(component) - Return a list of components that declare to implement the extension point interface.

milestone_change_listeners

List of components that implement ~trac.ticket.api.IMilestoneChangeListener

Get Method:: unreachable.extensions(component) - Return a list of components that declare to implement the extension point interface.

Class TicketSystem

ticket_custom_section(...)

__init__(self) (Constructor)

get_ticket_fields(self)

get_field_synonyms(self)

get_allowed_owners(self, ticket=None)

action_controllers

allowed_empty_fields

max_description_size

reserved_field_names

change_listeners

milestone_change_listeners

init(self)
(Constructor)