GrouperDigitalMarketplaceGroup (Grouper API 2.5.0-SNAPSHOT Java API.)

java.lang.Object
- edu.internet2.middleware.grouper.app.remedy.digitalMarketplace.GrouperDigitalMarketplaceGroup

public class GrouperDigitalMarketplaceGroup
extends Object

grouper box group

Constructor Summary

Constructors
Constructor and Description

GrouperDigitalMarketplaceGroup()

Constructors
Constructor and Description
`GrouperDigitalMarketplaceGroup()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`assignUserToGroup(GrouperDigitalMarketplaceUser grouperDigitalMarketplaceUser, boolean isIncremental)`
`static void`	`clearGroupCache()`
`String`	`getComments()` group description
`String`	`getGroupName()` extension
`String`	`getGroupType()` e.g.
`String`	`getLongGroupName()` display extension
`Collection<GrouperDigitalMarketplaceMembership>`	`getMemberships()` lazy load memberships
`Map<String,GrouperDigitalMarketplaceUser>`	`getMemberUsers()`
`String`	`getResourceType()` e.g.
`Boolean`	`removeUserFromGroup(GrouperDigitalMarketplaceUser grouperDigitalMarketplaceUser, boolean isIncremental)`
`GrouperDigitalMarketplaceMembership`	`retrieveGrouperRemedyMemership(GrouperDigitalMarketplaceUser grouperDigitalMarketplaceUser)` get a membership from a group
`static Map<String,GrouperDigitalMarketplaceGroup>`	`retrieveGroups()`
`void`	`setComments(String comments1)` group description
`void`	`setGroupName(String groupName1)` extension
`void`	`setGroupType(String groupType1)` e.g.
`void`	`setLongGroupName(String longGroupName1)` display extension
`void`	`setResourceType(String resourceType1)` e.g.

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

- Constructor Detail
  - GrouperDigitalMarketplaceGroup
```
public GrouperDigitalMarketplaceGroup()
```
- Method Detail
  - clearGroupCache
```
public static void clearGroupCache()
```
  - retrieveGroups
```
public static Map<String,GrouperDigitalMarketplaceGroup> retrieveGroups()
```
    Returns:
    
    box api connection never null
  - getComments
```
public String getComments()
```
    group description
    
    Returns:
    
    the comments
  - setComments
```
public void setComments(String comments1)
```
    group description
    
    Parameters:
    
    comments1 - the comments to set
  - getGroupName
```
public String getGroupName()
```
    extension
    
    Returns:
    
    the permissionGroup
  - setGroupName
```
public void setGroupName(String groupName1)
```
    extension
    
    Parameters:
    
    groupName1 - the permissionGroup to set
  - getLongGroupName
```
public String getLongGroupName()
```
    display extension
    
    Returns:
    
    the permissionGroupId
  - setLongGroupName
```
public void setLongGroupName(String longGroupName1)
```
    display extension
    
    Parameters:
    
    longGroupName1 - the permissionGroupId to set
  - getResourceType
```
public String getResourceType()
```
    e.g. com.bmc.arsys.rx.services.group.domain.RegularGroup
    
    Returns:
    
    the resourceType
  - setResourceType
```
public void setResourceType(String resourceType1)
```
    e.g. com.bmc.arsys.rx.services.group.domain.RegularGroup
    
    Parameters:
    
    resourceType1 - the resourceType to set
  - getGroupType
```
public String getGroupType()
```
    e.g. Change
    
    Returns:
    
    the groupType
  - setGroupType
```
public void setGroupType(String groupType1)
```
    e.g. Change
    
    Parameters:
    
    groupType1 - the groupType to set
  - getMemberships
```
public Collection<GrouperDigitalMarketplaceMembership> getMemberships()
```
    lazy load memberships
    
    Returns:
    
    memberships
  - retrieveGrouperRemedyMemership
```
public GrouperDigitalMarketplaceMembership retrieveGrouperRemedyMemership(GrouperDigitalMarketplaceUser grouperDigitalMarketplaceUser)
```
    get a membership from a group
    
    Parameters:
    
    grouperDigitalMarketplaceUser -
    
    Returns:
    
    the membership
  - getMemberUsers
```
public Map<String,GrouperDigitalMarketplaceUser> getMemberUsers()
```
    Returns:
    
    the map of loginids to user objects never return null. do not include disabled memberships
  - assignUserToGroup
```
public Boolean assignUserToGroup(GrouperDigitalMarketplaceUser grouperDigitalMarketplaceUser,
                                 boolean isIncremental)
```
    Parameters:
    
    grouperDigitalMarketplaceUser -
    
    isIncremental -
    
    Returns:
    
    true if added, false if already exists, null if enabled a past disabled memberships
  - removeUserFromGroup
```
public Boolean removeUserFromGroup(GrouperDigitalMarketplaceUser grouperDigitalMarketplaceUser,
                                   boolean isIncremental)
```
    Parameters:
    
    grouperDigitalMarketplaceUser -
    
    isIncremental -
    
    Returns:
    
    true if disabled, false if didnt exist, null if disabled a past enabled membership

Class GrouperDigitalMarketplaceGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GrouperDigitalMarketplaceGroup

Method Detail

clearGroupCache

retrieveGroups

getComments

setComments

getGroupName

setGroupName

getLongGroupName

setLongGroupName

getResourceType

setResourceType

getGroupType

setGroupType

getMemberships

retrieveGrouperRemedyMemership

getMemberUsers

assignUserToGroup

removeUserFromGroup