Package com.appiancorp.suiteapi.process
Class Assignment.Assignee
java.lang.Object
com.appiancorp.suiteapi.process.Assignment.Assignee
- All Implemented Interfaces:
JSONable
,JSONCacheable
,AppianTypeHolder
,Serializable
- Enclosing class:
- Assignment
A user, group, role, or function that is assigned to a task.
- See Also:
-
Field Summary
Fields inherited from interface com.appiancorp.suiteapi.common.JSONable
hiddenAttributes$TRANSIENT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
fillInAppianTypes
(AppianTypeCache cache_) Adds the primary key of the assignee to the given cache.Retrieves the displayname for the assignee, such as the group name for a group or username for userReturns the set of attributes (properties) that should not be included in the JSON representation of the object.Gets the reassignment privileges for this assignee.getType()
Retrieves the type of this assignee, as one of the ASSIGNEE_XXX constants.getValue()
void
setDisplayName
(String displayName_) Sets the displayname for the assignee, such as a group name for a group or username for user.void
setPrivilege
(Long privilege_) Sets the reassignment privileges for this assignee.void
Sets the type of the assignee.void
Sets the value for this assignee.void
toXML
(StringBuffer buffer_) Creates an XML representation of this assignee and appends it to the given StringBuffer.void
toXML
(StringBuilder buffer_)
-
Constructor Details
-
Assignee
public Assignee() -
Assignee
-
-
Method Details
-
toXML
Creates an XML representation of this assignee and appends it to the given StringBuffer.- Parameters:
buffer_
- a buffer of text
-
toXML
-
fillInAppianTypes
Adds the primary key of the assignee to the given cache.- Specified by:
fillInAppianTypes
in interfaceAppianTypeHolder
- Parameters:
cache_
- a cache of Appian-typed objects.
-
getPrivilege
Gets the reassignment privileges for this assignee. SeesetPrivilege(Long)
. -
setPrivilege
Sets the reassignment privileges for this assignee. Must be one of the PRIVILEGE_XXX constants onAssignment
. -
getValue
- Returns:
- the value for this assignee, i.e. the username, groupId, etc.
-
setValue
Sets the value for this assignee.- Parameters:
value_
- the value to set for the assignee
-
getType
Retrieves the type of this assignee, as one of the ASSIGNEE_XXX constants.- Returns:
- one of the ASSIGNEE_XXX constants indicating the type of the assignee
-
setType
Sets the type of the assignee.- Parameters:
type_
- the type to set for the assignee, which should be one of the ASSIGNEE_XXX constants.
-
getDisplayName
Retrieves the displayname for the assignee, such as the group name for a group or username for user- Returns:
- the displayname for the assignee. Note that this value is NOT set by the backend.
-
setDisplayName
Sets the displayname for the assignee, such as a group name for a group or username for user.- Parameters:
displayName_
- the displayname to set for the assignee. Note that this value is NOT stored in the backend.
-
getHiddenAttributes
Description copied from interface:JSONable
Returns the set of attributes (properties) that should not be included in the JSON representation of the object.- Specified by:
getHiddenAttributes
in interfaceJSONable
- Returns:
- the set of hidden attributes
-