Package com.avoka.tm.svc
Class GroupSvc
- java.lang.Object
-
- com.avoka.tm.svc.GroupSvc
-
- Direct Known Subclasses:
FormGroupSvc
public class GroupSvc extends Object
Provides a Group Service which supports create, delete, deleteOrPurge a group (Job | Alert | Form)
Examples
Please find the Group service examples below.
Create an Alert Group
This example shows how to create an alert
Group
object.import com.avoka.tm.svc.* import com.avoka.tm.vo.* Group group = GroupSvc.getAlertGroupSvc() .setGroupName("AlertGroup1") .setDescription("Description") .createGroup()
Create a Job Group
This example shows how to create a job
Group
object.import com.avoka.tm.svc.* import com.avoka.tm.vo.* Group group = GroupSvc.getJobGroupSvc() .setGroupName("JobGroup1") .setDescription("Description") .createGroup()
Create a Form Group
*This example shows how to create a form Group
Group
object.import com.avoka.tm.svc.* import com.avoka.tm.vo.* Group group = GroupSvc.getFormGroupSvc() .setGroupName("FormGroup1") .setDescription("Description") .setFormWorkGroupFlag(true) .setNewFormFlag(true) .setSavedFormFlag(true) .setCompletedFormFlag(true) .isTaskAssignFlag(true) .createGroup();
- Since:
- 21.11.0
- See Also:
FormGroupSvc
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
completedFormFlag
protected String
description
protected boolean
formWorkGroupFlag
protected String
groupName
protected String
groupType
protected boolean
isTaskAssignFlag
protected boolean
newFormFlag
protected boolean
savedFormFlag
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Group
createGroup()
Create a new group and return the new group object.void
deleteGroup(String groupName)
Delete the group specified.boolean
deleteOrPurgeGroup(String groupName)
Delete or purge the group specified.static GroupSvc
getAlertGroupSvc()
Create an instance of Alert type GroupSvcstatic FormGroupSvc
getFormGroupSvc()
Create an instance of FormGroupSvc.static GroupSvc
getJobGroupSvc()
Create an instance of Job type GroupSvcGroupSvc
setDescription(String description)
Set the description value.GroupSvc
setGroupName(String groupName)
Set the group name value.
-
-
-
Field Detail
-
description
protected String description
-
groupName
protected String groupName
-
groupType
protected String groupType
-
formWorkGroupFlag
protected boolean formWorkGroupFlag
-
newFormFlag
protected boolean newFormFlag
-
savedFormFlag
protected boolean savedFormFlag
-
completedFormFlag
protected boolean completedFormFlag
-
isTaskAssignFlag
protected boolean isTaskAssignFlag
-
-
Constructor Detail
-
GroupSvc
@FluentSecurityPermission(permissions="group-edit") protected GroupSvc(String groupType)
-
-
Method Detail
-
getAlertGroupSvc
public static GroupSvc getAlertGroupSvc()
Create an instance of Alert type GroupSvc- Returns:
- instance of Alert Group service
-
getFormGroupSvc
public static FormGroupSvc getFormGroupSvc()
Create an instance of FormGroupSvc.- Returns:
- instance of Form Group Service
-
getJobGroupSvc
public static GroupSvc getJobGroupSvc()
Create an instance of Job type GroupSvc- Returns:
- instance of Job Group Service
-
setDescription
public GroupSvc setDescription(String description)
Set the description value.- Parameters:
description
- the description of the group- Returns:
- the Group service
-
setGroupName
public GroupSvc setGroupName(String groupName)
Set the group name value.- Parameters:
groupName
- the name of the group- Returns:
- the Group service
-
createGroup
public Group createGroup()
Create a new group and return the new group object.- Returns:
- the newly created Group value object
-
deleteOrPurgeGroup
@FluentSecurityPermission(permissions="group-remove") public boolean deleteOrPurgeGroup(String groupName)
Delete or purge the group specified. If there is any related objects, group will be marked to delete later when all related objects purged.- Parameters:
groupName
- the name of the group which should be deleted- Returns:
- true if group deleted or false if group is marked to delete later
-
deleteGroup
@FluentSecurityPermission(permissions="group-remove") public void deleteGroup(String groupName)
Delete the group specified.- Parameters:
groupName
- the name of the group which should be deleted
-
-