com.ibm.task.api

Interface GroupDetail

All Superinterfaces:
java.io.Serializable

  1. public interface GroupDetail
  2. extends java.io.Serializable
Interface for accessing group details.
Since:
6.1.2

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getGroupName()
Returns the name of the group that is described by this object.
  1. java.util.List
getProperty(java.lang.String property)
Returns the named group property.
  1. java.util.List
getPropertyNames()
Returns the names of all group properties that are described by this object.
  1. java.util.List
getSubgroupDetails()
Returns the description of subgroups directly contained in the group.
  1. java.util.List
getUserDetails()
Returns the description of users directly contained in the group.
  1. boolean
isInDirectory()
States whether the group is described in the people directory.

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

Method Detail

getGroupName

  1. java.lang.String getGroupName()
Returns the name of the group that is described by this object.
Returns:
The group name

isInDirectory

  1. boolean isInDirectory()
States whether the group is described in the people directory.
Returns:
True states that the group is found in the people directory. False states that the group is not found in the people directory, that is, properties are not returned.

getProperty

  1. java.util.List getProperty(java.lang.String property)
Returns the named group property.
Parameters:
property - The name of the group property that is to be returned.
Returns:
The requested property. More than one string is returned when the property is multi-valued.

getPropertyNames

  1. java.util.List getPropertyNames( )
Returns the names of all group properties that are described by this object.
Returns:
A list of group property names that are contained in this object.

getUserDetails

  1. java.util.List getUserDetails()
Returns the description of users directly contained in the group.
Returns:
A list of UserDetail objects. Returns an empty list when user details are not contained in this object.

getSubgroupDetails

  1. java.util.List getSubgroupDetails( )
Returns the description of subgroups directly contained in the group.
Returns:
A list of GroupDetail objects. Returns an empty list when subgroup details are not contained in this object.