Class UsersGroup

Description
Description | Vars | Methods (details)

The Everyone Group contains all other Agents and Groups in the system, including the Anonymous Agent. Agents and Groups cannot be added or removed from this group as they are always in it.

OSID Version: 2.0

  • version: $Id: UsersGroup.class.php,v 1.11 2007/09/13 16:04:17 adamfranco Exp $
  • license: GNU General Public License (GPL)
  • copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/agent/UsersGroup.class.php (line 22) 

HarmoniAgent
   |
   --HarmoniGroup
      |
      --UsersGroup
Method Summary
Description | Vars | Methods (details)
UsersGroup UsersGroup (integer 0)
void add (mixed $memberOrGroup, object Agent $memberOrGroup )
void attach (object memberOrGroup $memberOrGroup)
boolean contains (object Agent $memberOrGroup, mixed $searchSubgroups, boolean $searchSubgroups )
string getDescription ()
string getDisplayName ()
object AgentIterator getGroups (mixed $includeSubgroups, boolean $includeSubgroups )
object Id getId ()
object AgentIterator getMembers (mixed $includeSubgroups, boolean $includeSubgroups )
object Type getType ()
void remove (mixed $memberOrGroup, object Agent $memberOrGroup )
void updateDescription (mixed $description, string $description )
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from HarmoniAgent

HarmoniAgent::$_hierarchy
 HarmoniAgent::$_idString
 HarmoniAgent::$_node
Methods
Description | Vars Methods (details)
Constructor UsersGroup (line 32)

The constructor.

  • access: public
UsersGroup UsersGroup (integer 0)
  • integer 0: dbIndex The database connection as returned by the DBHandler.
add (line 182)

Add an Agent or a Group to this Group. The Agent or Group will not be added if it already exists in the group.

  • access: public
  • throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, ALREADY_ADDED, NULL_ARGUMENT
void add (mixed $memberOrGroup, object Agent $memberOrGroup )
  • object Agent $memberOrGroup
Redefinition of:
HarmoniGroup::add()
Add an Agent or a Group to this Group. The Agent or Group will not be added if it already exists in the group.
attach (line 206)

An implementation-specific public method that does exactly the same as add(), but does not insert into the database.

  • throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, ALREADY_ADDED, NULL_ARGUMENT
  • access: public
void attach (object memberOrGroup $memberOrGroup)
  • object memberOrGroup $memberOrGroup
contains (line 319)

Return 

  1. true
    2.
if the Member or Group is in the Group, optionally including subgroups, 
  1. false
    2.
otherwise.

  • access: public
  • throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT
boolean contains (object Agent $memberOrGroup, mixed $searchSubgroups, boolean $searchSubgroups )
  • object Agent $memberOrGroup
  • boolean $searchSubgroups
Redefinition of:
HarmoniGroup::contains()
Return 
  1. true
    2.
if the Member or Group is in the Group, optionally including subgroups, 
  1. false
    2.
otherwise.
getDescription (line 88)

Get the Description of this Group.

  • access: public
  • throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
string getDescription ()
Redefinition of:
HarmoniGroup::getDescription()
Get the Description of this Group.
getDisplayName (line 66)

Get the name of this Agent.

  • access: public
  • throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
string getDisplayName ()
Redefinition of:
HarmoniAgent::getDisplayName()
Get the name of this Agent.
getGroups (line 288)

Get all the Groups in this group and optionally all the subgroups in this group. Note since Groups subclass Agents, we are returning an AgentIterator and there is no GroupIterator.

  • access: public
  • throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
object AgentIterator getGroups (mixed $includeSubgroups, boolean $includeSubgroups )
  • boolean $includeSubgroups
Redefinition of:
HarmoniGroup::getGroups()
Get all the Groups in this group and optionally all the subgroups in this group. Note since Groups subclass Agents, we are returning an AgentIterator and there is no GroupIterator.
getId (line 110)

Get the id of this Agent.

  • access: public
  • throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
object Id getId ()
Redefinition of:
HarmoniAgent::getId()
Get the id of this Agent.
getMembers (line 258)

Get all the Members of this group and optionally all the Members from all subgroups. Duplicates are not returned.

  • access: public
  • throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
object AgentIterator getMembers (mixed $includeSubgroups, boolean $includeSubgroups )
  • boolean $includeSubgroups
Redefinition of:
HarmoniGroup::getMembers()
Get all the Members of this group and optionally all the Members from all subgroups. Duplicates are not returned.
getType (line 132)

Get the type of this Agent.

  • access: public
  • throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
object Type getType ()
Redefinition of:
HarmoniAgent::getType()
Get the type of this Agent.
remove (line 232)

Remove an Agent member or a Group from this Group. If the Agent or Group is not in this group no action is taken and no exception is thrown.

  • access: public
  • throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, UNKNOWN_ID, NULL_ARGUMENT
void remove (mixed $memberOrGroup, object Agent $memberOrGroup )
  • object Agent $memberOrGroup
Redefinition of:
HarmoniGroup::remove()
Remove an Agent member or a Group from this Group. If the Agent or Group is not in this group no action is taken and no exception is thrown.
updateDescription (line 156)

Update the Description of this Group.

  • access: public
  • throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT
void updateDescription (mixed $description, string $description )
  • string $description
Redefinition of:
HarmoniGroup::updateDescription()
Update the Description of this Group.

Inherited Methods

Inherited From HarmoniGroup

HarmoniGroup::add()
HarmoniGroup::contains()
HarmoniGroup::getDescription()
HarmoniGroup::getGroups()
HarmoniGroup::getMembers()
HarmoniGroup::isGroup()
HarmoniGroup::remove()
HarmoniGroup::updateDescription()

Inherited From HarmoniAgent

HarmoniAgent::HarmoniAgent()
HarmoniAgent::getDisplayName()
HarmoniAgent::getId()
HarmoniAgent::getProperties()
HarmoniAgent::getPropertiesByType()
HarmoniAgent::getPropertyTypes()
HarmoniAgent::getType()
HarmoniAgent::isAgent()
HarmoniAgent::isGroup()

Documentation generated on Wed, 19 Sep 2007 10:27:41 -0400 by phpDocumentor 1.3.0RC3