EntityGroup (Sakai Entity Broker Core Providers 10.6 API)

java.lang.Object
- org.sakaiproject.entitybroker.providers.model.EntityGroup

All Implemented Interfaces:

Serializable, Comparable, org.sakaiproject.authz.api.AuthzGroup, org.sakaiproject.entity.api.Edit, org.sakaiproject.entity.api.Entity, org.sakaiproject.site.api.Group
```
@ReflectIgnoreClassFields(value={"createdBy","modifiedBy","containingSite","members","properties","propertiesEdit","roles"})
public class EntityGroup
extends Object
implements org.sakaiproject.site.api.Group
```
This is needed to allow RESTful access to the group data

Author:

Aaron Zeckoski (azeckoski @ gmail.com)

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

Map<String,String> props
- Fields inherited from interface org.sakaiproject.site.api.Group
  GROUP_PROP_JOINABLE_SET, GROUP_PROP_JOINABLE_SET_MAX, GROUP_PROP_JOINABLE_SET_PREVIEW, GROUP_PROP_JOINABLE_UNJOINABLE, GROUP_PROP_VIEW_MEMBERS, GROUP_PROP_WSETUP_CREATED
- Fields inherited from interface org.sakaiproject.entity.api.Entity
  SEPARATOR

Fields
Modifier and Type	Field and Description
`Map<String,String>`	`props`

Constructor Summary

Constructors
Constructor and Description
`EntityGroup()`
`EntityGroup(org.sakaiproject.site.api.Group group)`
`EntityGroup(String siteId, String title, String description, String maintainRole, String providerGroupId, String owner)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMember(String arg0, String arg1, boolean arg2, boolean arg3)`
`org.sakaiproject.authz.api.Role`	`addRole(String arg0)`
`org.sakaiproject.authz.api.Role`	`addRole(String arg0, org.sakaiproject.authz.api.Role arg1)`
`int`	`compareTo(Object o)`
`org.sakaiproject.site.api.Site`	`getContainingSite()`
`org.sakaiproject.user.api.User`	`getCreatedBy()`
`Date`	`getCreatedDate()`
`org.sakaiproject.time.api.Time`	`getCreatedTime()`
`String`	`getDescription()`
`String`	`getId()`
`String`	`getJoinerRole()`
`long`	`getLastModified()`
`String`	`getMaintainRole()`
`org.sakaiproject.authz.api.Member`	`getMember(String arg0)`
`Set`	`getMembers()`
`org.sakaiproject.user.api.User`	`getModifiedBy()`
`Date`	`getModifiedDate()`
`org.sakaiproject.time.api.Time`	`getModifiedTime()`
`String`	`getOwner()`
`org.sakaiproject.entity.api.ResourceProperties`	`getProperties()`
`org.sakaiproject.entity.api.ResourcePropertiesEdit`	`getPropertiesEdit()`
`String`	`getProperty(String key)`
`Map<String,String>`	`getProps()`
`String`	`getProviderGroupId()`
`String`	`getReference()`
`String`	`getReference(String arg0)`
`org.sakaiproject.authz.api.Role`	`getRole(String arg0)`
`Set`	`getRoles()`
`Set`	`getRolesIsAllowed(String arg0)`
`String`	`getSiteId()`
`Owner`	`getSiteOwner()` Special method
`String`	`getTitle()`
`String`	`getUrl()`
`String`	`getUrl(String arg0)`
`org.sakaiproject.authz.api.Role`	`getUserRole(String arg0)`
`String[]`	`getUserRoles()`
`Set`	`getUsers()`
`Set`	`getUsersHasRole(String arg0)`
`Set`	`getUsersIsAllowed(String arg0)`
`boolean`	`hasRole(String arg0, String arg1)`
`boolean`	`isActiveEdit()`
`boolean`	`isAllowed(String arg0, String arg1)`
`boolean`	`isEmpty()`
`boolean`	`keepIntersection(org.sakaiproject.authz.api.AuthzGroup arg0)`
`void`	`removeMember(String arg0)`
`void`	`removeMembers()`
`void`	`removeRole(String arg0)`
`void`	`removeRoles()`
`void`	`setDescription(String description)`
`void`	`setId(String id)`
`void`	`setJoinerRole(String joinerRole)`
`void`	`setLastModified(long lastModified)`
`void`	`setMaintainRole(String maintainRole)`
`void`	`setOwner(String owner)`
`void`	`setProperty(String key, String value)`
`void`	`setProps(Map<String,String> props)`
`void`	`setProviderGroupId(String providerGroupId)`
`void`	`setSiteId(String siteId)`
`void`	`setTitle(String title)`
`void`	`setUserRoles(String[] userRoles)`
`Element`	`toXml(Document arg0, Stack arg1)`

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

- Field Detail
  - props
```
public Map<String,String> props
```
- Constructor Detail
  - EntityGroup
```
public EntityGroup()
```
  - EntityGroup
```
public EntityGroup(String siteId,
           String title,
           String description,
           String maintainRole,
           String providerGroupId,
           String owner)
```
  - EntityGroup
```
public EntityGroup(org.sakaiproject.site.api.Group group)
```
- Method Detail
  - getProps
```
public Map<String,String> getProps()
```
  - setProps
```
public void setProps(Map<String,String> props)
```
  - setProperty
```
public void setProperty(String key,
               String value)
```
  - getProperty
```
public String getProperty(String key)
```
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface org.sakaiproject.entity.api.Entity
  - setId
```
public void setId(String id)
```
  - getSiteId
```
public String getSiteId()
```
  - setSiteId
```
public void setSiteId(String siteId)
```
  - getOwner
```
public String getOwner()
```
    Returns:
    the id of the owner of this group (will match the created by user id)
  - setOwner
```
public void setOwner(String owner)
```
  - getSiteOwner
```
public Owner getSiteOwner()
```
    Special method
    
    Returns:
    the owner data for the current site owner
  - getLastModified
```
public long getLastModified()
```
  - setLastModified
```
public void setLastModified(long lastModified)
```
  - getTitle
```
public String getTitle()
```
    Specified by:
    
    getTitle in interface org.sakaiproject.site.api.Group
  - setTitle
```
public void setTitle(String title)
```
    Specified by:
    
    setTitle in interface org.sakaiproject.site.api.Group
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface org.sakaiproject.authz.api.AuthzGroup
    
    Specified by:
    
    getDescription in interface org.sakaiproject.site.api.Group
  - setDescription
```
public void setDescription(String description)
```
    Specified by:
    
    setDescription in interface org.sakaiproject.site.api.Group
  - getJoinerRole
```
public String getJoinerRole()
```
  - setJoinerRole
```
public void setJoinerRole(String joinerRole)
```
  - getMaintainRole
```
public String getMaintainRole()
```
    Specified by:
    
    getMaintainRole in interface org.sakaiproject.authz.api.AuthzGroup
  - setMaintainRole
```
public void setMaintainRole(String maintainRole)
```
    Specified by:
    
    setMaintainRole in interface org.sakaiproject.authz.api.AuthzGroup
  - getProviderGroupId
```
public String getProviderGroupId()
```
    Specified by:
    
    getProviderGroupId in interface org.sakaiproject.authz.api.AuthzGroup
  - setProviderGroupId
```
public void setProviderGroupId(String providerGroupId)
```
    Specified by:
    
    setProviderGroupId in interface org.sakaiproject.authz.api.AuthzGroup
  - getUserRoles
```
public String[] getUserRoles()
```
  - setUserRoles
```
public void setUserRoles(String[] userRoles)
```
  - getCreatedBy
```
public org.sakaiproject.user.api.User getCreatedBy()
```
    Specified by:
    
    getCreatedBy in interface org.sakaiproject.authz.api.AuthzGroup
  - getCreatedTime
```
public org.sakaiproject.time.api.Time getCreatedTime()
```
    Specified by:
    
    getCreatedTime in interface org.sakaiproject.authz.api.AuthzGroup
  - getCreatedDate
```
public Date getCreatedDate()
```
    Specified by:
    
    getCreatedDate in interface org.sakaiproject.authz.api.AuthzGroup
  - getModifiedBy
```
public org.sakaiproject.user.api.User getModifiedBy()
```
    Specified by:
    
    getModifiedBy in interface org.sakaiproject.authz.api.AuthzGroup
  - getModifiedTime
```
public org.sakaiproject.time.api.Time getModifiedTime()
```
    Specified by:
    
    getModifiedTime in interface org.sakaiproject.authz.api.AuthzGroup
  - getModifiedDate
```
public Date getModifiedDate()
```
    Specified by:
    
    getModifiedDate in interface org.sakaiproject.authz.api.AuthzGroup
  - getPropertiesEdit
```
public org.sakaiproject.entity.api.ResourcePropertiesEdit getPropertiesEdit()
```
    Specified by:
    
    getPropertiesEdit in interface org.sakaiproject.entity.api.Edit
  - isActiveEdit
```
public boolean isActiveEdit()
```
    Specified by:
    
    isActiveEdit in interface org.sakaiproject.entity.api.Edit
  - getProperties
```
public org.sakaiproject.entity.api.ResourceProperties getProperties()
```
    Specified by:
    
    getProperties in interface org.sakaiproject.entity.api.Entity
  - getReference
```
public String getReference()
```
    Specified by:
    
    getReference in interface org.sakaiproject.entity.api.Entity
  - getReference
```
public String getReference(String arg0)
```
    Specified by:
    
    getReference in interface org.sakaiproject.entity.api.Entity
  - getUrl
```
public String getUrl()
```
    Specified by:
    
    getUrl in interface org.sakaiproject.entity.api.Entity
  - getUrl
```
public String getUrl(String arg0)
```
    Specified by:
    
    getUrl in interface org.sakaiproject.entity.api.Entity
  - toXml
```
@ReflectTransient
public Element toXml(Document arg0,
                             Stack arg1)
```
    Specified by:
    
    toXml in interface org.sakaiproject.entity.api.Entity
  - compareTo
```
public int compareTo(Object o)
```
    Specified by:
    
    compareTo in interface Comparable
  - addMember
```
public void addMember(String arg0,
             String arg1,
             boolean arg2,
             boolean arg3)
```
    Specified by:
    
    addMember in interface org.sakaiproject.authz.api.AuthzGroup
  - addRole
```
public org.sakaiproject.authz.api.Role addRole(String arg0)
                                        throws org.sakaiproject.authz.api.RoleAlreadyDefinedException
```
    Specified by:
    
    addRole in interface org.sakaiproject.authz.api.AuthzGroup
    
    Throws:
    
    org.sakaiproject.authz.api.RoleAlreadyDefinedException
  - addRole
```
public org.sakaiproject.authz.api.Role addRole(String arg0,
                                      org.sakaiproject.authz.api.Role arg1)
                                        throws org.sakaiproject.authz.api.RoleAlreadyDefinedException
```
    Specified by:
    
    addRole in interface org.sakaiproject.authz.api.AuthzGroup
    
    Throws:
    
    org.sakaiproject.authz.api.RoleAlreadyDefinedException
  - getMember
```
public org.sakaiproject.authz.api.Member getMember(String arg0)
```
    Specified by:
    
    getMember in interface org.sakaiproject.authz.api.AuthzGroup
  - getMembers
```
public Set getMembers()
```
    Specified by:
    
    getMembers in interface org.sakaiproject.authz.api.AuthzGroup
  - getRole
```
public org.sakaiproject.authz.api.Role getRole(String arg0)
```
    Specified by:
    
    getRole in interface org.sakaiproject.authz.api.AuthzGroup
  - getRoles
```
public Set getRoles()
```
    Specified by:
    
    getRoles in interface org.sakaiproject.authz.api.AuthzGroup
  - getRolesIsAllowed
```
public Set getRolesIsAllowed(String arg0)
```
    Specified by:
    
    getRolesIsAllowed in interface org.sakaiproject.authz.api.AuthzGroup
  - getUserRole
```
public org.sakaiproject.authz.api.Role getUserRole(String arg0)
```
    Specified by:
    
    getUserRole in interface org.sakaiproject.authz.api.AuthzGroup
  - getUsers
```
public Set getUsers()
```
    Specified by:
    
    getUsers in interface org.sakaiproject.authz.api.AuthzGroup
  - getUsersHasRole
```
public Set getUsersHasRole(String arg0)
```
    Specified by:
    
    getUsersHasRole in interface org.sakaiproject.authz.api.AuthzGroup
  - getUsersIsAllowed
```
public Set getUsersIsAllowed(String arg0)
```
    Specified by:
    
    getUsersIsAllowed in interface org.sakaiproject.authz.api.AuthzGroup
  - hasRole
```
public boolean hasRole(String arg0,
              String arg1)
```
    Specified by:
    
    hasRole in interface org.sakaiproject.authz.api.AuthzGroup
  - isAllowed
```
public boolean isAllowed(String arg0,
                String arg1)
```
    Specified by:
    
    isAllowed in interface org.sakaiproject.authz.api.AuthzGroup
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.sakaiproject.authz.api.AuthzGroup
  - keepIntersection
```
public boolean keepIntersection(org.sakaiproject.authz.api.AuthzGroup arg0)
```
    Specified by:
    
    keepIntersection in interface org.sakaiproject.authz.api.AuthzGroup
  - removeMember
```
public void removeMember(String arg0)
```
    Specified by:
    
    removeMember in interface org.sakaiproject.authz.api.AuthzGroup
  - removeMembers
```
public void removeMembers()
```
    Specified by:
    
    removeMembers in interface org.sakaiproject.authz.api.AuthzGroup
  - removeRole
```
public void removeRole(String arg0)
```
    Specified by:
    
    removeRole in interface org.sakaiproject.authz.api.AuthzGroup
  - removeRoles
```
public void removeRoles()
```
    Specified by:
    
    removeRoles in interface org.sakaiproject.authz.api.AuthzGroup
  - getContainingSite
```
public org.sakaiproject.site.api.Site getContainingSite()
```
    Specified by:
    
    getContainingSite in interface org.sakaiproject.site.api.Group

Class EntityGroup

Field Summary

Fields inherited from interface org.sakaiproject.site.api.Group

Fields inherited from interface org.sakaiproject.entity.api.Entity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

props

Constructor Detail

EntityGroup

EntityGroup

EntityGroup

Method Detail

getProps

setProps

setProperty

getProperty

getId

setId

getSiteId

setSiteId

getOwner

setOwner

getSiteOwner

getLastModified

setLastModified

getTitle

setTitle

getDescription

setDescription

getJoinerRole

setJoinerRole

getMaintainRole

setMaintainRole

getProviderGroupId

setProviderGroupId

getUserRoles

setUserRoles

getCreatedBy

getCreatedTime

getCreatedDate

getModifiedBy

getModifiedTime

getModifiedDate

getPropertiesEdit

isActiveEdit

getProperties

getReference

getReference

getUrl

getUrl

toXml

compareTo

addMember

addRole

addRole

getMember

getMembers

getRole

getRoles

getRolesIsAllowed

getUserRole

getUsers

getUsersHasRole

getUsersIsAllowed

hasRole

isAllowed

isEmpty

keepIntersection

removeMember

removeMembers

removeRole

removeRoles

getContainingSite