NAME

  RT::CustomField_Overlay 

DESCRIPTION

'CORE' METHODS

Create PARAMHASH

Create takes a hash of values and creates a row in the database:

  varchar(200) 'Name'.
  varchar(200) 'Type'.
  int(11) 'Queue'.
  varchar(255) 'Description'.
  int(11) 'SortOrder'.
  smallint(6) 'Disabled'.

LoadByNameAndQueue (Queue => QUEUEID, Name => NAME)

Loads the Custom field named NAME for Queue QUEUE. If QUEUE is 0, loads a global custom field

AddValue HASH

Create a new value for this CustomField. Takes a paramhash containing the elements Name, Description and SortOrder

DeleteValue ID

Deletes a value from this custom field by id.

Does not remove this value for any article which has had it selected

Values FIELD

Return a CustomFieldeValues object of all acceptable values for this Custom Field.

ValuesForTicket TICKET

Returns a RT::TicketCustomFieldValues object of this Field's values for TICKET. TICKET is a ticket id.

AddValueForTicket HASH

Adds a custom field value for a ticket. Takes a param hash of Ticket and Content

DeleteValueForTicket HASH

Adds a custom field value for a ticket. Takes a param hash of Ticket and Content

ValidateQueue Queue

Make sure that the queue specified is a valid queue name

Types

Retuns an array of the types of CustomField that are supported

FriendlyType [TYPE]

Returns a localized human-readable version of the custom field type. If a custom field type is specified as the parameter, the friendly type for that type will be returned

ValidateType TYPE

Takes a single string. returns true if that string is a value type of custom field

SingleValue

Returns true if this CustomField only accepts a single value. Returns false if it accepts multiple values

CurrentUserHasRight RIGHT

Helper function to call the custom field's queue's CurrentUserHasRight with the passed in args.

_Value

Takes the name of a table column. Returns its value as a string, if the user passes an ACL check

SetDisabled

Takes a boolean. 1 will cause this custom field to no longer be avaialble for tickets. 0 will re-enable this queue