RT::Tickets(3)

NAME
  RT::Tickets - A collection of Ticket objects

SYNOPSIS
  use RT::Tickets;
  my $tickets = new RT::Tickets($CurrentUser);

DESCRIPTION
   A collection of RT::Tickets.

METHODS

  SortFields
Returns the list of fields that lists of tickets can easily be sorted by

  Limit
Takes a paramhash with the fields FIELD, OPERATOR, VALUE and DESCRIPTION Generally best called from LimitFoo methods

  FreezeLimits
Returns a frozen string suitable for handing back to ThawLimits.

  ThawLimits
Take a frozen Limits string generated by FreezeLimits and make this tickets object have that set of limits.

  LimitQueue
LimitQueue takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of = or !=. (It defaults to =). VALUE is a queue id.

  LimitStatus
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of = or !=. VALUE is a status.

  LimitType
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of = or !=, it defaults to "=". VALUE is a string to search for in the type of the ticket.

  LimitSubject
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of = or !=. VALUE is a string to search for in the subject of the ticket.

  LimitId
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, >, < or !=. VALUE is a ticket Id to search for

  LimitPriority
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, >, < or !=. VALUE is a value to match the ticket\'s priority against

  LimitInitialPriority
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, >, < or !=. VALUE is a value to match the ticket\'s initial priority against

  LimitFinalPriority
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, >, < or !=. VALUE is a value to match the ticket\'s final priority against

  LimitTimeWorked
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, >, < or !=. VALUE is a value to match the ticket's TimeWorked attribute

  LimitTimeLeft
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, >, < or !=. VALUE is a value to match the ticket's TimeLeft attribute

  LimitContent
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, LIKE, NOT LIKE or !=. VALUE is a string to search for in the body of the ticket

  LimitContentType
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, LIKE, NOT LIKE or !=. VALUE is a content type to search ticket attachments for

  LimitOwner
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of = or !=. VALUE is a user id.

  LimitWatcher
  Takes a paramhash with the fields OPERATOR, TYPE and VALUE.
  OPERATOR is one of =, LIKE, NOT LIKE or !=.
  VALUE is a value to match the ticket\'s watcher email addresses against
  TYPE is the sort of watchers you want to match against. Leave it undef if you want to search all of them

  LimitRequestor
It\'s like LimitWatcher, but it presets TYPE to Requestor

  LimitCC
It\'s like LimitWatcher, but it presets TYPE to Cc

  LimitAdminCc
It\'s like LimitWatcher, but it presets TYPE to AdminCc

  LimitLinkedTo
LimitLinkedTo takes a paramhash with two fields: TYPE and TARGET TYPE limits the sort of relationship we want to search on

TARGET is the id or URI of the TARGET of the link (TARGET used to be 'TICKET'. 'TICKET' is deprecated, but will be treated as TARGET

  LimitLinkedFrom
LimitLinkedFrom takes a paramhash with two fields: TYPE and BASE TYPE limits the sort of relationship we want to search on

BASE is the id or URI of the BASE of the link (BASE used to be 'TICKET'. 'TICKET' is deprecated, but will be treated as BASE

  LimitDate (FIELD => 'DateField', OPERATOR => $oper, VALUE => $ISODate)
Takes a paramhash with the fields FIELD OPERATOR and VALUE.

OPERATOR is one of > or < VALUE is a date and time in ISO format in GMT FIELD is one of Starts, Started, Told, Created, Resolved, LastUpdated

There are also helper functions of the form LimitFIELD that eliminate the need to pass in a FIELD argument.

  LimitTransactionDate (OPERATOR => $oper, VALUE => $ISODate)
Takes a paramhash with the fields FIELD OPERATOR and VALUE.

OPERATOR is one of > or < VALUE is a date and time in ISO format in GMT

  LimitKeyword
Takes a paramhash of key/value pairs with the following keys:

KEYWORDSELECT - KeywordSelect id
OPERATOR - (for KEYWORD only - KEYWORDSELECT operator is always `=')
KEYWORD - Keyword id

  _NextIndex
Keep track of the counter for the array of restrictions

  ItemsArrayRef
Returns a reference to the set of all items found in this search

  LoadRestrictions
LoadRestrictions takes a string which can fully populate the TicketRestrictons hash. TODO It is not yet implemented

  DescribeRestrictions
takes nothing. Returns a hash keyed by restriction id. Each element of the hash is currently a one element hash that contains DESCRIPTION which is a description of the purpose of that TicketRestriction

  RestrictionValues FIELD
Takes a restriction field and returns a list of values this field is restricted to.

  ClearRestrictions
Removes all restrictions irretrievably

  DeleteRestriction
Takes the row Id of a restriction (From DescribeRestrictions' output, for example. Removes that restriction from the session's limits.

  SetListingFormat
Takes a single Format string as specified below. parses that format string and makes the various listing output things DTRT.

Format strings
    Format strings are made up of a chain of Elements delimited with vertical pipes (|). Elements of a Format string

    FormatString: Element[::FormatString]

    Element: AttributeName[;HREF=<URL>][;TITLE=<TITLE>]

    AttributeName Id | Subject | Status | Owner | Priority | InitialPriority | TimeWorked | TimeLeft |

                     Keywords[;SELECT=<KeywordSelect>] |

                    <Created|Starts|Started|Contacted|Due|Resolved>Date<AsString|AsISO|AsAge>

  notes "Enum" Things that get Is, IsNot
"Int" Things that get Is LessThan and GreaterThan id InitialPriority FinalPriority Priority TimeLeft TimeWorked

"Text" Things that get Is, Like Subject TransactionContent

"Link" OPERATORs

"Date" OPERATORs Is, Before, After

  =cut
# }}}
1;

POD ERRORS
Hey! The above document had some coding errors, which are explained below:

Around line 1536:
    '=item' outside of any '=over'

Around line 1765:
    You forgot a '=back' before '=head2'