com.plumtree.server
Interface IPTActivityGroups

All Superinterfaces:

IPTUnknown

public interface IPTActivityGroups
extends IPTUnknown

Interface used for granting rights to groups, revoking rights from groups, and querying for the rights of a group.

Author:

Joseph Chen

Method Summary

IPTMigratable	GetActivityRight(int activityID) Retrieves an activity for migration.
void	GrantRightToGroups(int activityID, java.lang.Object[] groupIDs) Grant the right to an activity to a list of groups.
IPTQueryResult	QueryAllGroups(int activityID) Returns all of the groups that have the right to the specified activity.
IPTQueryResult	QueryGroups(int activityID, int propIDMask, int skipRows, int maxRows) Returns all of the groups that have the right to the specified activity.
void	RevokeRightFromGroups(int activityID, java.lang.Object[] groupIDs) Revoke the right to an activity from a list of groups.

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

QueryGroups

IPTQueryResult QueryGroups(int activityID,
                           int propIDMask,
                           int skipRows,
                           int maxRows)

Returns all of the groups that have the right to the specified activity.

Parameters:

activityID - Activity ID

propIDMask - PT_PROPIDS mask

skipRows - Number of rows to skip

maxRows - Maximum number of rows to return

Returns:

Results of the query

QueryAllGroups

IPTQueryResult QueryAllGroups(int activityID)

Returns all of the groups that have the right to the specified activity.

Parameters:

activityID - Activity ID

Returns:

Results of the query

GrantRightToGroups

void GrantRightToGroups(int activityID,
                        java.lang.Object[] groupIDs)

Grant the right to an activity to a list of groups.
User's must have the "delegate rights" right in order to grant the right.
User must have the right to the activity in order to grant the right.
When right is granted, current user's activity rights cache is flushed.

Parameters:

activityID - Activity ID

groupIDs - Array of group IDs

RevokeRightFromGroups

void RevokeRightFromGroups(int activityID,
                           java.lang.Object[] groupIDs)

Revoke the right to an activity from a list of groups.
User must have the "delegate rights" right in order to revoke the right.
User must have the right to the activity in order to revoke the right.
When right is revoked, current user's activity rights cache is flushed.
Rights cannot be revoked from the admin group.

Parameters:

activityID - Activity ID

groupIDs - Array of group IDs

GetActivityRight

IPTMigratable GetActivityRight(int activityID)

Retrieves an activity for migration.

Parameters:

activityID - Activity ID

Returns:

IPTMigratable interface of an activity