public interface IDfGroup extends IDfPersistentObject
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
boolean |
addGroup(java.lang.String groupName)
Adds a group to this group.
|
boolean |
addUser(java.lang.String userName)
Adds a user to this group.
|
IDfId |
getAliasSetId()
Returns the alias set object id of the group.
|
java.lang.String |
getAllUsersNames(int index)
Returns the name (at a specified index) from all users in a group object, including users that belong to group
objects contained within this group object.
|
int |
getAllUsersNamesCount()
Returns the number of users in a group object, including users that belong to group objects contained within this
group object.
|
java.lang.String |
getDescription()
Returns the user-defined description of a group object.
|
boolean |
getDynamic()
Gets the dynamic setting of this group
|
boolean |
getDynamicDefault()
Gets the default membership setting for the dynamic group.
|
java.lang.String |
getGroupAddress()
Returns the electronic mail address for a group object.
|
java.lang.String |
getGroupAdmin()
Gets the admin of this group.
|
java.lang.String |
getGroupClass()
Gets the class of this gruop.
|
IDfId |
getGroupDirectoryId() |
java.lang.String |
getGroupDisplayName()
Gets the display name of a group.
|
java.lang.String |
getGroupGlobalUniqueId() |
java.lang.String |
getGroupName()
Returns the name of a group object.
|
IDfId |
getGroupNativeRoomId()
Gets the group native room id.
|
IDfCollection |
getGroupsNames()
Returns a collection of group members' names in this group.
|
java.lang.String |
getGroupsNames(int index)
Returns the name of a group that is a member in a group object at the specified index.
|
int |
getGroupsNamesCount()
Returns the number of groups that are users in a group object.
|
java.lang.String |
getGroupSource() |
boolean |
getHasEvents() |
IDfTime |
getModifyDate()
Returns the time and date that a group object was last modified.
|
java.lang.String |
getOwnerName()
Returns the user name of the user who created a group object.
|
java.lang.String |
getSupergroupsNames(int index) |
int |
getSupergroupsNamesCount() |
IDfCollection |
getUsersNames()
Returns a collection of user members' names in this group.
|
java.lang.String |
getUsersNames(int index)
Returns the name of the user in a group object at a specified index.
|
int |
getUsersNamesCount()
Returns the number of users in a Group object.
|
boolean |
isGloballyManaged()
Indicates whether the ACL associated with a group object is globally or locally managed.
|
boolean |
isGroupInGroup(java.lang.String groupName)
Determines whether the group is one of the members of this group.
|
boolean |
isPrivate()
Indicates whether a group object is private or public.
|
boolean |
isUserInGroup(java.lang.String userName)
Determines whether the user is one of the members of this group.
|
void |
removeAllGroups()
Removes all groups from this group.
|
void |
removeAllUsers()
Removes all users from this group.
|
boolean |
removeGroup(java.lang.String groupName)
Add a group to this group.
|
boolean |
removeUser(java.lang.String userName)
Removes a user to this group.
|
void |
renameGroup(java.lang.String groupName,
boolean isImmediate,
boolean unlockObjects,
boolean reportOnly)
Rename this group.
|
void |
renameGroupEx(java.lang.String groupName,
boolean isImmediate,
boolean unlockObjects,
boolean reportOnly,
java.lang.String groupDisplayName)
Rename this group.
|
void |
setAliasSetId(IDfId aliasId)
Sets the alias set object id of the group.
|
void |
setDescription(java.lang.String description)
Sets the description of this group.
|
void |
setDynamic(boolean isDynamic)
Marks the group as a dynamic group
|
void |
setDynamicDefault(boolean isDynamicDefault)
Marks the dynamic group as having its membership be included by default for members when they connect.
|
void |
setGloballyManaged(boolean isGloballyManaged)
Sets if this group is globally managed (by Federation) or local.
|
void |
setGroupAddress(java.lang.String groupAddress)
Sets the e-mail address of this group.
|
void |
setGroupAdmin(java.lang.String admin)
Sets the admin of this group.
|
void |
setGroupClass(java.lang.String className)
Sets the class of this group.
|
void |
setGroupDirectoryId(IDfId value) |
void |
setGroupDisplayName(java.lang.String value)
Sets the display name of a group.
|
void |
setGroupGlobalUniqueId(java.lang.String value) |
void |
setGroupName(java.lang.String groupName)
Sets the name of this group.
|
void |
setGroupNativeRoomId(IDfId value)
Sets the group native room id.
|
void |
setGroupSource(java.lang.String value) |
void |
setOwnerName(java.lang.String ownerName)
Sets the owner of this group.
|
void |
setPrivate(boolean isPrivate)
Sets if this group is private or public
|
addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
java.lang.String getOwnerName() throws DfException
DfException
- if a server error occursjava.lang.String getGroupName() throws DfException
DfException
- if a server error occursjava.lang.String getGroupAddress() throws DfException
DfException
- if a server error occursjava.lang.String getUsersNames(int index) throws DfException
DfException
- if a server error occursint getUsersNamesCount() throws DfException
DfException
- if a server error occursjava.lang.String getGroupsNames(int index) throws DfException
DfException
- if a server error occursint getGroupsNamesCount() throws DfException
DfException
- if a server error occursboolean isPrivate() throws DfException
DfException
- if a server error occursjava.lang.String getDescription() throws DfException
DfException
- if a server error occursjava.lang.String getAllUsersNames(int index) throws DfException
DfException
- if a server error occursint getAllUsersNamesCount() throws DfException
DfException
- if a server error occursboolean isGloballyManaged() throws DfException
DfException
- if a server error occursIDfTime getModifyDate() throws DfException
DfException
- if a server error occursIDfId getAliasSetId() throws DfException
DfException
- if a server error occurs.void setAliasSetId(IDfId aliasId) throws DfException
DfException
- if a server error occurs.boolean isUserInGroup(java.lang.String userName) throws DfException
userName
- user name of the userDfException
boolean isGroupInGroup(java.lang.String groupName) throws DfException
groupName
- group name of the groupDfException
void renameGroup(java.lang.String groupName, boolean isImmediate, boolean unlockObjects, boolean reportOnly) throws DfException
DfException
void renameGroupEx(java.lang.String groupName, boolean isImmediate, boolean unlockObjects, boolean reportOnly, java.lang.String groupDisplayName) throws DfException
DfException
- if an error occurs.void setGroupName(java.lang.String groupName) throws DfException
groupName
- name of this group to be renamed toDfException
void setGroupAddress(java.lang.String groupAddress) throws DfException
groupAddress
- e-mail address of this groupDfException
void setDescription(java.lang.String description) throws DfException
description
- description of this group.DfException
void setPrivate(boolean isPrivate) throws DfException
isPrivate
- true
If this group is private. false
If this group is public.DfException
void setOwnerName(java.lang.String ownerName) throws DfException
ownerName
- owner name of this group.DfException
void setGloballyManaged(boolean isGloballyManaged) throws DfException
isGloballyManaged
- true
If this group is managed by Federation. false
If this
group is manged locally.DfException
boolean addUser(java.lang.String userName) throws DfException
userName
- name of a user to be added.DfException
boolean addGroup(java.lang.String groupName) throws DfException
groupName
- name of a group to be added.DfException
boolean removeUser(java.lang.String userName) throws DfException
userName
- name of a user to be removed.DfException
boolean removeGroup(java.lang.String groupName) throws DfException
groupName
- name of a group to be removed.DfException
void removeAllUsers() throws DfException
DfException
void removeAllGroups() throws DfException
DfException
IDfCollection getUsersNames() throws DfException
DfException
- if a server error occursIDfCollection getGroupsNames() throws DfException
DfException
- if a server error occursvoid setGroupClass(java.lang.String className) throws DfException
className
- The class of this group.DfException
java.lang.String getGroupClass() throws DfException
DfException
void setGroupAdmin(java.lang.String admin) throws DfException
admin
- The admin of this group. If this is not a valid group, an exception is thrown.DfException
java.lang.String getGroupAdmin() throws DfException
DfException
void setDynamic(boolean isDynamic) throws DfException
isDynamic
- true
If this group is dynamic. false
If this group is not dynamic.DfException
boolean getDynamic() throws DfException
true
if the group is a dynamic group; false
if the group is not.DfException
void setDynamicDefault(boolean isDynamicDefault) throws DfException
isDynamicDefault
- true
If this group's membership is default. false
If this
group's membership is not default.DfException
boolean getDynamicDefault() throws DfException
true
if the group's dynamic_default flag is on; false
if the dynamic_default
flag is not on.DfException
int getSupergroupsNamesCount() throws DfException
DfException
java.lang.String getSupergroupsNames(int index) throws DfException
DfException
java.lang.String getGroupSource() throws DfException
DfException
void setGroupSource(java.lang.String value) throws DfException
DfException
boolean getHasEvents() throws DfException
DfException
java.lang.String getGroupGlobalUniqueId() throws DfException
DfException
void setGroupGlobalUniqueId(java.lang.String value) throws DfException
DfException
IDfId getGroupNativeRoomId() throws DfException
DfException
- if a server error occursvoid setGroupNativeRoomId(IDfId value) throws DfException
DfException
- if a server error occursIDfId getGroupDirectoryId() throws DfException
DfException
void setGroupDirectoryId(IDfId value) throws DfException
DfException
java.lang.String getGroupDisplayName() throws DfException
DfException
- if a server error occursvoid setGroupDisplayName(java.lang.String value) throws DfException
DfException
- if a server error occursCopyright 1994-2023 OpenText Corporation. All rights reserved.