org.eclipse.stardust.engine.api.runtime
Interface UserGroup

All Superinterfaces:
DynamicParticipant, DynamicParticipantInfo, ModelElement, Participant, ParticipantInfo, Serializable, UserGroupInfo

public interface UserGroup
extends DynamicParticipant, UserGroupInfo

A client side view of an user group participant defined at runtime. An user group participant is a workflow element which performs manual or interactive activities.

Version:
$Revision$
Author:
sborn

Method Summary
 String getDescription()
          Retrieves this user group's description.
 org.eclipse.stardust.engine.api.dto.UserGroupDetailsLevel getDetailsLevel()
           
 void setAttribute(String name, Serializable value)
           
 void setDescription(String description)
          Sets the description of the user group.
 void setName(String name)
          Sets the name of the user group.
 void setValidFrom(Date validFrom)
          Sets the validity start date of the user group.
 void setValidTo(Date validTo)
          Sets the validity end date of the user group.
 
Methods inherited from interface org.eclipse.stardust.engine.api.model.DynamicParticipant
getPartitionId, getPartitionOID, getValidFrom, getValidTo
 
Methods inherited from interface org.eclipse.stardust.engine.api.model.Participant
getAllAttributes, getAllSuperOrganizations, getAttribute, getElementOID, getModelOID, getNamespace
 
Methods inherited from interface org.eclipse.stardust.engine.api.model.ModelElement
getId, getName, getQualifiedId
 
Methods inherited from interface org.eclipse.stardust.engine.api.model.DynamicParticipantInfo
getOID
 
Methods inherited from interface org.eclipse.stardust.engine.api.model.ParticipantInfo
getId, getName, getQualifiedId
 

Method Detail

setName

void setName(String name)
Sets the name of the user group. The actual name will not be changed until UserService.modifyUserGroup(UserGroup) is invoked.

Parameters:
name - the new name.
See Also:
UserService.modifyUserGroup(UserGroup)

setValidFrom

void setValidFrom(Date validFrom)
Sets the validity start date of the user group. The actual date will not be changed until UserService.modifyUserGroup(UserGroup) is invoked.

Parameters:
validFrom - the validity start date, or null if unlimited.
See Also:
UserService.modifyUserGroup(UserGroup)

setValidTo

void setValidTo(Date validTo)
Sets the validity end date of the user group. The actual date will not be changed until UserService.modifyUserGroup(UserGroup) is invoked.

Parameters:
validTo - the validity end date, or null if unlimited.
See Also:
UserService.modifyUserGroup(UserGroup)

getDescription

String getDescription()
Retrieves this user group's description.

Specified by:
getDescription in interface ModelElement
Returns:
the description.

setDescription

void setDescription(String description)
Sets the description of the user group. The actual description will not be changed until UserService.modifyUserGroup(UserGroup) is invoked.

Parameters:
description - the description.
See Also:
UserService.modifyUserGroup(UserGroup)

setAttribute

void setAttribute(String name,
                  Serializable value)
Parameters:
name -
value -

getDetailsLevel

org.eclipse.stardust.engine.api.dto.UserGroupDetailsLevel getDetailsLevel()


Copyright © 2017 Eclipse Stardust. All Rights Reserved.