RT::Group(3)

NAME
  RT::Group - RT\'s group object

SYNOPSIS
  use RT::Group;
my $group = new RT::Group($CurrentUser);

DESCRIPTION
An RT group object.

AUTHOR
Jesse Vincent, jesse@fsck.com

SEE ALSO
RT

METHODS

  Load
Load a group object from the database. Takes a single argument. If the argument is numerical, load by the column 'id'. Otherwise, load by the "Name" column which is the group's textual name

  Create
Takes a paramhash with three named arguments: Name, Description and Pseudo. Pseudo is used internally by RT for certain special ACL decisions.

  Delete
Delete this object

  MembersObj
Returns an RT::GroupMembers object of this group's members.

  AddMember
AddMember adds a user to this group. It takes a user id. Returns a two value array. the first value is true on successful addition or 0 on failure. The second value is a textual status msg.

  HasMember
Takes a user Id and returns a GroupMember Id if that user is a member of this group. Returns undef if the user isn't a member of the group or if the current user doesn't have permission to find out. Arguably, it should differentiate between ACL failure and non membership.

  DeleteMember
Takes the user id of a member. If the current user has apropriate rights, removes that GroupMember from this group. Returns a two value array. the first value is true on successful addition or 0 on failure. The second value is a textual status msg.

  GrantQueueRight
Grant a queue right to this group. Takes a paramhash of which the elements RightAppliesTo and RightName are important.

  GrantSystemRight
Grant a system right to this group. The only element that's important to set is RightName.