oracle.ifs.fdk
Interface GroupManager

public interface GroupManager

The group management Facade interface.

Method Summary

Item	addUsers(long groupId, NamedValue[] def, AttributeRequest[] attributes) Adds members and managers to an existing group.
Item	createGroup(NamedValue[] def, AttributeRequest[] attributes) Creates a new group, returning an Item that represents it.
void	deleteGroup(long groupId) Deletes a group.
Item[]	findGroups(NamedValue[] def, AttributeRequest[] attributes) Gets a list of Groups with the specified attributes.
Item	removeUsers(long groupId, NamedValue[] def, AttributeRequest[] attributes) Removes members and managers from an existing group.
Item	updateGroup(long groupId, NamedValue[] def, AttributeRequest[] attributes) Updates a group.

Method Detail

createGroup

public Item createGroup(NamedValue[] def,
                        AttributeRequest[] attributes)
                 throws FdkException

Creates a new group, returning an Item that represents it.

The returned Item will be of the type Group.

Parameters:

def - Attributes of the new group. Valid attributes:

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.MEMBER_LIST, long[]}
• {Attributes.MANAGER_LIST, long[]}
• {Attributes.IS_EXTERNALLY_MANAGED, Boolean}
• {Attributes.MEMBERSHIP_VISIBILITY, Integer}

attributes - Additional attributes on the new group to return.

Returns:

a Group with the requested attributes.

Throws:

FdkException - if the operation fails

updateGroup

public Item updateGroup(long groupId,
                        NamedValue[] def,
                        AttributeRequest[] attributes)
                 throws FdkException

Updates a group. If set, the member list and manager list of the group will be exactly what is specified, ignoring the current lists. If the attribute is not set, the corresponding list will be left as is.

Note that it is preferable to update the member/manager lists using add/removeUsers unless it is impossible or expensive to calculate the necessary changes.

Parameters:

groupId - The id of the group to update.

def - New attributes of the group. Valid attributes:

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.MEMBER_LIST, long[]}
• {Attributes.MANAGER_LIST, long[]}
• {Attributes.IS_EXTERNALLY_MANAGED, Boolean}
• {Attributes.MEMBERSHIP_VISIBILITY, Integer}

attributes - Additional attributes on the group to return.

Returns:

a Group with the requested attributes.

Throws:

FdkException - if the operation fails

addUsers

public Item addUsers(long groupId,
                     NamedValue[] def,
                     AttributeRequest[] attributes)
              throws FdkException

Adds members and managers to an existing group. Only users may be added to the manager list. Note that specifying a user as a manager when that user is already on the member list, will cause the user to be removed from the member list and added to the manager list (keeping in mind that all managers are implicit members of the group).

Parameters:

groupId - The id of the group to update.

def - New attributes of the group. Valid attributes:

• notation: {Attribute name, Attribute type}
• {Attributes.MEMBER_LIST, long[]}
• {Attributes.MANAGER_LIST, long[]}

attributes - Additional attributes on the group to return.

Returns:

a Group with the requested attributes.

Throws:

FdkException - if the operation fails

removeUsers

public Item removeUsers(long groupId,
                        NamedValue[] def,
                        AttributeRequest[] attributes)
                 throws FdkException

Removes members and managers from an existing group. Note that a removed manager will still be a member; to remove a manager from the group entirely, specify the manager under MEMBER_LIST.

Parameters:

groupId - The id of the group to update.

def - New attributes of the group. Valid attributes:

• notation: {Attribute name, Attribute type}
• {Attributes.MEMBER_LIST, long[]}
• {Attributes.MANAGER_LIST, long[]}

attributes - Additional attributes on the group to return.

Returns:

a Group with the requested attributes.

Throws:

FdkException - if the operation fails

deleteGroup

public void deleteGroup(long groupId)
                 throws FdkException

Deletes a group.

Parameters:

groupId - The id of the group to delete.

Throws:

FdkException - if the operation fails

findGroups

public Item[] findGroups(NamedValue[] def,
                         AttributeRequest[] attributes)
                  throws FdkException

Gets a list of Groups with the specified attributes. Note that the NAME attribute is a name filter; database and Windows wildcards (_?%*) accepted. Also note that the HAS_MEMBER option indicates a direct member; groups that contain the specified user as a manager or as a member of a subgroup will not be returned.

The returned Items will be of the type Group.

Parameters:

def - Optional restrictions/sort options. Valid Attributes:

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.IS_EXTERNALLY_MANAGED, Boolean}
• {Options.HAS_MEMBER, Long}
• {Options.HAS_MANAGER, Long}
• {Options.IS_MEMBER_OF, Boolean}, If you pass in FALSE then this option will be ignored
• {Options.IS_MANAGER_OF, Boolean}, If you pass in FALSE then this option will be ignored
• {Options.PRIMARY_SORT_ATTRIBUTE, String}
• {Options.PRIMARY_SORT_DIRECTION, Boolean}
• {Options.SECONDARY_SORT_ATTRIBUTE, String}
• {Options.SECONDARY_SORT_DIRECTION, Boolean}

If an attribute name is specified with no direction, ascending is the default. Attribute names must be valid attributes in Attributes.java and must return values that implement Comparable.

attributes - Attributes to return on the list of groups.

Returns:

a list of Items representing the requested groups.

Throws:

FdkException - if the operation fails