Docs For Class LDAPGroup

Class LDAPGroup

Description

Implements interfaces:

Group

<##>

version: $Id: LDAPGroup.class.php,v 1.3 2007/08/22 14:45:45 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 2/24/06

Located in /harmoni/core/oki2/agentmanagement/AuthNMethods/LDAPGroup.class.php (line 26)

Method Summary

object LDAPGroup (string $idString, mixed $type, object Properties $configuration, mixed $authNMethod)

void add (mixed $memberOrGroup, object Agent $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 PropertiesIterator getProperties ()

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object TypeIterator getPropertyTypes ()

object Type getType ()

boolean isAgent ()

boolean isGroup ()

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

void updateDescription (mixed $description, string $description )

object AgentIterator _getMyGroups ()

object AgentIterator _getMyMembers ()

object AgentIterator _getSubgroupGroups ()

object AgentIterator _getSubgroupMembers ()

Methods

Constructor LDAPGroup (line 39)

Constructor.

since: 2/24/06
access: public

object LDAPGroup (string $idString, mixed $type, object Properties $configuration, mixed $authNMethod)

string $idString
object Properties $configuration

add (line 195)

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

contains (line 426)

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

getDescription (line 96)

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

getDisplayName (line 144)

Get the DisplayName 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 getDisplayName ()

getGroups (line 340)

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

getId (line 118)

Get the unique Id 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

object Id getId ()

getMembers (line 246)

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

getProperties (line 524)

Get the Properties associated with 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

object PropertiesIterator getProperties ()

getPropertiesByType (line 476)

Get the Properties of this Type associated with 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, UNKNOWN_TYPE

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object Type $propertiesType

getPropertyTypes (line 502)

Get all the property Types. The returned iterator provides access to

the property Types from this implementation one at a time. Iterators have a method hasNextType() which returns true if there is another property Type available and a method nextType() which returns the next property Type. 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

object TypeIterator getPropertyTypes ()

getType (line 169)

Get the Type 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

object Type getType ()

isAgent (line 539)

Answer true if this Agent is an Agent, not a group

WARNING: NOT IN OSID

since: 12/7/06
access: public

boolean isAgent ()

isGroup (line 552)

Answer true if this Agent is an Group

WARNING: NOT IN OSID

since: 12/7/06
access: public

boolean isGroup ()

remove (line 221)

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

updateDescription (line 74)

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

_getMyGroups (line 355)

Answer the direct child groups of this group

since: 2/27/06
access: private

object AgentIterator _getMyGroups ()

_getMyMembers (line 261)

Answer the direct members of this group

since: 2/27/06
access: private

object AgentIterator _getMyMembers ()

_getSubgroupGroups (line 381)

Answer the descendent groups of this group

since: 2/27/06
access: private

object AgentIterator _getSubgroupGroups ()

_getSubgroupMembers (line 292)

Answer the members of this group both directly and in subgroups

since: 2/27/06
access: private

object AgentIterator _getSubgroupMembers ()

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