• • Load IDENTIFIER
  • AddRights RIGHT, DESCRIPTION [, ...]
  • AddRightCategories RIGHT, CATEGORY [, ...]
  • AvailableRights
  • Create PARAMHASH
• AppliedTo
• NotAppliedTo
  • IsApplied
  • AddToObject OBJECT
  • RemoveFromObject OBJECT
  • id
  • Name
  • SetName VALUE
  • Description
  • SetDescription VALUE
  • SortOrder
  • SetSortOrder VALUE
  • Disabled
  • SetDisabled VALUE
  • HotList
  • SetHotList VALUE
  • Creator
  • Created
  • LastUpdatedBy
  • LastUpdated

Load IDENTIFIER

Loads a class, either by name or by id

AddRights RIGHT, DESCRIPTION [, ...]

Adds the given rights to the list of possible rights. This method should be called during server startup, not at runtime.

AddRightCategories RIGHT, CATEGORY [, ...]

Adds the given right and category pairs to the list of right categories. This method should be called during server startup, not at runtime.

AvailableRights

Returns a hash of available rights for this object. The keys are the right names and the values are a description of what t he rights do

Create PARAMHASH

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

  varchar(255) 'Name'.
  varchar(255) 'Description'.
  int(11) 'SortOrder'.

AppliedTo

Returns collection of Queues this Class is applied to. Doesn't takes into account if object is applied globally.

NotAppliedTo

Returns collection of Queues this Class is not applied to.

Doesn't takes into account if object is applied globally.

IsApplied

Takes object id and returns corresponding RT::ObjectClass record if this Class is applied to the object. Use 0 to check if Class is applied globally.

AddToObject OBJECT

Apply this Class to a single object, to start with we support Queues

Takes an object

RemoveFromObject OBJECT

Remove this class from a single queue object

id

Returns the current value of id. (In the database, id is stored as int(11).)

Name

Returns the current value of Name. (In the database, Name is stored as varchar(255).)

SetName VALUE

Set Name to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Name will be stored as a varchar(255).)

Description

Returns the current value of Description. (In the database, Description is stored as varchar(255).)

SetDescription VALUE

Set Description to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Description will be stored as a varchar(255).)

SortOrder

Returns the current value of SortOrder. (In the database, SortOrder is stored as int(11).)

SetSortOrder VALUE

Set SortOrder to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, SortOrder will be stored as a int(11).)

Disabled

Returns the current value of Disabled. (In the database, Disabled is stored as int(2).)

SetDisabled VALUE

Set Disabled to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Disabled will be stored as a int(2).)

HotList

Returns the current value of HotList. (In the database, HotList is stored as int(2).)

SetHotList VALUE

Set HotList to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, HotList will be stored as a int(2).)

Creator

Returns the current value of Creator. (In the database, Creator is stored as int(11).)

Created

Returns the current value of Created. (In the database, Created is stored as datetime.)

LastUpdatedBy

Returns the current value of LastUpdatedBy. (In the database, LastUpdatedBy is stored as int(11).)

LastUpdated

Returns the current value of LastUpdated. (In the database, LastUpdated is stored as datetime.)

← Back to index