Docs For Class EveryoneGroup

Description

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: EveryoneGroup.class.php,v 1.7 2007/08/22 14:45:44 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/agent/EveryoneGroup.class.php (line 21)

HarmoniAgent
   |
   --HarmoniGroup
      |
      --EveryoneGroup

Method Summary

void add (mixed $memberOrGroup, object Agent $memberOrGroup )

void attach (object memberOrGroup $memberOrGroup)

boolean contains (object Agent $memberOrGroup, mixed $searchSubgroups, boolean $searchSubgroups )

object AgentIterator getGroups (mixed $includeSubgroups, boolean $includeSubgroups )

object AgentIterator getMembers (mixed $includeSubgroups, boolean $includeSubgroups )

void remove (mixed $memberOrGroup, object Agent $memberOrGroup )

void updateDescription (mixed $description, string $description )

Variables

Inherited Variables

Inherited from HarmoniAgent

HarmoniAgent::$_hierarchy
HarmoniAgent::$_idString
HarmoniAgent::$_node

Methods

add (line 71)

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 95)

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 225)

Return

true

if the Member or Group is in the Group, optionally including subgroups,

false

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

true

if the Member or Group is in the Group, optionally including subgroups,

false

otherwise.

getGroups (line 177)

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.

getMembers (line 147)

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.

remove (line 121)

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 45)

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()