Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jasig.portal.channels.groupsmanager.wrappers
Class GroupWrapper

    java.lang.Object
      org.jasig.portal.channels.groupsmanager.wrappers.GroupMemberWrapper
          org.jasig.portal.channels.groupsmanager.wrappers.GroupWrapper

All Implemented Interfaces:
  GroupsManagerConstants, IGroupsManagerWrapper

    public class GroupWrapper

extends GroupMemberWrapper

Returns an xml element for a given IEntityGroup or IEntityGroup key.

Version:
  $Revision: 1.21 $
Author:
  Don Fracapane

Field Summary
`private boolean` | `limitRetrievals`
`private int` | `retrievalLimit`

Fields inherited from class org.jasig.portal.channels.groupsmanager.wrappers.GroupMemberWrapper
`ELEMENT_TAGNAME`

Fields inherited from interface org.jasig.portal.channels.groupsmanager.GroupsManagerConstants
`ADD_REMOVE_PERMISSION, ASSIGN_PERMISSION, BASE_PACKAGE, BROWSE_MODE, COMMANDS_PACKAGE, CREATE_PERMISSION, DELETE_PERMISSION, EDIT_MODE, ENTITY_CLASSNAME, ENTITY_TAGNAME, GROUP_CLASSNAME, GROUP_TAGNAME, GROUPS_PACKAGE, MEMBERS_ONLY_MODE, OWNER, PROPERTIES_TAGNAME, ROOT_GROUP_DESCRIPTION, ROOT_GROUP_TITLE, SECURITY_PACKAGE, SELECT_MODE, SELECT_PERMISSION, UPDATE_PERMISSION, VIEW_PERMISSION, WRAPPERS_PACKAGE`

Constructor Summary
`GroupWrapper()` Creates new GroupWrapper

Method Summary
`private org.w3c.dom.Element` | `expandElement(IGroupMember gm, org.w3c.dom.Element anElem, CGroupsManagerUnrestrictedSessionData sessionData)` Returns the xml element for a given IEntityGroup, populated with child elements.
`org.w3c.dom.Element` | `getXml(IGroupMember gm, org.w3c.dom.Element anElem, CGroupsManagerUnrestrictedSessionData sessionData)` Returns an xml element for a given IEntityGroup.
`protected IGroupMember` | `retrieveGroupMember(java.lang.String aKey, java.lang.String aType)` Returns a GroupMember for a key.

Methods inherited from class org.jasig.portal.channels.groupsmanager.wrappers.GroupMemberWrapper
`applyPermissions, getXml`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### limitRetrievals

    private boolean limitRetrievals

### retrievalLimit

    private int retrievalLimit

Constructor Detail

### GroupWrapper

    public GroupWrapper()

  Creates new GroupWrapper

Method Detail

### getXml

    public org.w3c.dom.Element getXml(IGroupMember gm,
                                      org.w3c.dom.Element anElem,
                                      CGroupsManagerUnrestrictedSessionData sessionData)

  Returns an xml element for a given IEntityGroup.

  Specified by:
    `getXml` in interface `IGroupsManagerWrapper`
  Specified by:
    `getXml` in class `GroupMemberWrapper`
  Parameters:
    `gm` - IGroupMember
    `anElem` - Element
    `sessionData` - CGroupsManagerUnrestrictedSessionData
  Returns:
    Element

### retrieveGroupMember

    protected IGroupMember retrieveGroupMember(java.lang.String aKey,
                                               java.lang.String aType)

  Returns a GroupMember for a key.

  Specified by:
    `retrieveGroupMember` in class `GroupMemberWrapper`
  Parameters:
    `aKey` - String
    `aType` - String
  Returns:
    IGroupMember

### expandElement

    private org.w3c.dom.Element expandElement(IGroupMember gm,
                                              org.w3c.dom.Element anElem,
                                              CGroupsManagerUnrestrictedSessionData sessionData)

  Returns the xml element for a given IEntityGroup, populated with child elements.

  Parameters:
    `gm` - IGroupMember
    `anElem` - Element
    `sessionData` - CGroupsManagerUnrestrictedSessionData
  Returns:
    Element

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD