com.appiancorp.suiteapi.process

Class Assignment.Assignee

java.lang.Object

com.appiancorp.suiteapi.process.Assignment.Assignee

All Implemented Interfaces:

JSONable, JSONCacheable, AppianTypeHolder, java.io.Serializable

Enclosing class:

Assignment

public static class Assignment.Assignee
extends java.lang.Object
implements JSONCacheable, AppianTypeHolder

A user, group, role, or function that is assigned to a task.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.appiancorp.suiteapi.common.JSONable

hiddenAttributes$TRANSIENT

Constructor Summary

Constructors

Constructor and Description
Assignee()
Assignee(java.lang.Long type, java.lang.Object value, java.lang.Long privilege)

Method Summary

Modifier and Type	Method and Description
void	fillInAppianTypes(AppianTypeCache cache_) Adds the primary key of the assignee to the given cache.
java.lang.String	getDisplayName() Retrieves the displayname for the assignee, such as the group name for a group or username for user
java.util.HashSet	getHiddenAttributes() Returns the set of attributes (properties) that should not be included in the JSON representation of the object.
java.lang.Long	getPrivilege() Gets the reassignment privileges for this assignee.
java.lang.Long	getType() Retrieves the type of this assignee, as one of the ASSIGNEE_XXX constants.
java.lang.Object	getValue()
void	setDisplayName(java.lang.String displayName_) Sets the displayname for the assignee, such as a group name for a group or username for user.
void	setPrivilege(java.lang.Long privilege_) Sets the reassignment privileges for this assignee.
void	setType(java.lang.Long type_) Sets the type of the assignee.
void	setValue(java.lang.Object value_) Sets the value for this assignee.
void	toXML(java.lang.StringBuffer buffer_) Creates an XML representation of this assignee and appends it to the given StringBuffer.
void	toXML(java.lang.StringBuilder buffer_)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Assignee

public Assignee()

Assignee

public Assignee(java.lang.Long type,
                java.lang.Object value,
                java.lang.Long privilege)

Method Detail

toXML

public void toXML(java.lang.StringBuffer buffer_)

Creates an XML representation of this assignee and appends it to the given StringBuffer.

Parameters:

buffer_ - a buffer of text

toXML

public void toXML(java.lang.StringBuilder buffer_)

fillInAppianTypes

public void fillInAppianTypes(AppianTypeCache cache_)

Adds the primary key of the assignee to the given cache.

Specified by:

fillInAppianTypes in interface AppianTypeHolder

Parameters:

cache_ - a cache of Appian-typed objects.

getPrivilege

public java.lang.Long getPrivilege()

Gets the reassignment privileges for this assignee. See setPrivilege(Long).

setPrivilege

public void setPrivilege(java.lang.Long privilege_)

Sets the reassignment privileges for this assignee. Must be one of the PRIVILEGE_XXX constants on Assignment.

getValue

public java.lang.Object getValue()

Returns:

the value for this assignee, i.e. the username, groupId, etc.

setValue

public void setValue(java.lang.Object value_)

Sets the value for this assignee.

Parameters:

value_ - the value to set for the assignee

getType

public java.lang.Long 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

public void setType(java.lang.Long type_)

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

public java.lang.String 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

public void setDisplayName(java.lang.String displayName_)

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

public java.util.HashSet 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 interface JSONable

Returns:

the set of hidden attributes