Package com.adobe.granite.taskmanagement
Enum TaskProperty
- java.lang.Object
-
- java.lang.Enum<TaskProperty>
-
- com.adobe.granite.taskmanagement.TaskProperty
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<TaskProperty>
public enum TaskProperty extends java.lang.Enum<TaskProperty>
Enumerates the built in task properties
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACTION_NAMES
The action names of the taskCOMPLETED_BY
The id for the user who completed the taskCOMPLETED_TIME
When the task was completedCONTENT_PATH
A content path the task is associated toCREATED_BY
The Id of the user who created this task.CREATED_TIME
The time the task was createdDESCRIPTION
The task descriptionDUE_TIME
the date when this task is dueINSTRUCTIONS
The task instructionsMODIFIED_BY
The id for the user who last modified the taskMODIFIED_TIME
The time the task was last modifiedNAME
The task nameNAME_HIERARCHY
name hierarchy for this task (co-insides with parent task id hierarchy)OWNER_ID
The name of the principal who owns the taskPARENT_TASK_ID
The Id of the parent taskPRIORITY
the priority of this taskPROGRESS_START_TIME
the date when progress should start on this taskSELECTED_ACTION
The action used to complete the taskSTATUS
The task statusTASK_TYPE_NAME
The task type
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getPropertyName()
Return the property name which can be used in task filter conditions.static TaskProperty
getTaskProperty(java.lang.String propertyName)
Return the TaskProperty object for the specified property namestatic boolean
isTaskProperty(java.lang.String propertyName)
Returns true if this is an intrinsic property (ie, one of DESCRIPTION, INSTRUCTIONS, ...static TaskProperty
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static TaskProperty[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NAME
public static final TaskProperty NAME
The task name
-
DESCRIPTION
public static final TaskProperty DESCRIPTION
The task description
-
INSTRUCTIONS
public static final TaskProperty INSTRUCTIONS
The task instructions
-
OWNER_ID
public static final TaskProperty OWNER_ID
The name of the principal who owns the task
-
TASK_TYPE_NAME
public static final TaskProperty TASK_TYPE_NAME
The task type
-
STATUS
public static final TaskProperty STATUS
The task status
-
CREATED_TIME
public static final TaskProperty CREATED_TIME
The time the task was created
-
CREATED_BY
public static final TaskProperty CREATED_BY
The Id of the user who created this task. In the case where this task was created by the system this field will be empty
-
MODIFIED_TIME
public static final TaskProperty MODIFIED_TIME
The time the task was last modified
-
MODIFIED_BY
public static final TaskProperty MODIFIED_BY
The id for the user who last modified the task
-
COMPLETED_TIME
public static final TaskProperty COMPLETED_TIME
When the task was completed
-
COMPLETED_BY
public static final TaskProperty COMPLETED_BY
The id for the user who completed the task
-
ACTION_NAMES
public static final TaskProperty ACTION_NAMES
The action names of the task
-
SELECTED_ACTION
public static final TaskProperty SELECTED_ACTION
The action used to complete the task
-
PARENT_TASK_ID
public static final TaskProperty PARENT_TASK_ID
The Id of the parent task
-
CONTENT_PATH
public static final TaskProperty CONTENT_PATH
A content path the task is associated to
-
NAME_HIERARCHY
public static final TaskProperty NAME_HIERARCHY
name hierarchy for this task (co-insides with parent task id hierarchy)
-
DUE_TIME
public static final TaskProperty DUE_TIME
the date when this task is due
-
PROGRESS_START_TIME
public static final TaskProperty PROGRESS_START_TIME
the date when progress should start on this task
-
PRIORITY
public static final TaskProperty PRIORITY
the priority of this task
-
-
Method Detail
-
values
public static TaskProperty[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (TaskProperty c : TaskProperty.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TaskProperty valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getPropertyName
public java.lang.String getPropertyName()
Return the property name which can be used in task filter conditions. seeTaskManager.getTasks(com.adobe.granite.taskmanagement.Filter)
seeCondition.setPropertyName(String)
- Returns:
- A String representing the property name of this instance or null if it has not been set
-
isTaskProperty
public static final boolean isTaskProperty(java.lang.String propertyName)
Returns true if this is an intrinsic property (ie, one of DESCRIPTION, INSTRUCTIONS, ... , ACTION_NAMES) and false otherwise.- Parameters:
propertyName
- The property name to check- Returns:
- true if an intrinsic property and false otherwise
-
getTaskProperty
public static final TaskProperty getTaskProperty(java.lang.String propertyName)
Return the TaskProperty object for the specified property name- Parameters:
propertyName
- used to specify the property name- Returns:
- an TaskProperty object for the specified property name and false if the property name is not an intrinsic property.
-
-