com.sas.hls.work.workitem
Class WorkItem

java.lang.Object
  extended by com.sas.hls.common.AbstractIdentifiable
      extended by com.sas.hls.work.workitem.WorkItem
All Implemented Interfaces:
Identifiable, Serializable

public class WorkItem
extends AbstractIdentifiable

A data object that represents a work item

See Also:
Serialized Form

Nested Class Summary
static class WorkItem.Status
          Status is an enum representing the status of the work item.
 
Field Summary
static String OBJECT_TYPE
          Represents the type name of a WorkItem object.
 
Constructor Summary
WorkItem(String identifier, ObjectIdentity context, String contextPath, String name, WorkItem.Status status, List<Attribute> attributes)
          Deprecated. Deprecated as of version 1.7. Please use WorkItem(String, ObjectIdentity, String, String, Status, String, List).
WorkItem(String identifier, ObjectIdentity context, String contextPath, String name, WorkItem.Status status, String owner, List<Attribute> attributes)
          Initializing constructor.
 
Method Summary
 Attribute getAttribute(String name)
          Return the attribute with the provided name.
 List<Attribute> getAttributes()
          Get the attributes of this work item
 ObjectIdentity getContext()
          Get the context for this work item
 String getContextPath()
          Get the path of the context for this work item
 String getName()
          Get the name for this work item
 String getOwner()
          Get the owner for this work item.
 WorkItem.Status getStatus()
          Get the status of this work item.
 String toString()
          Return a string representation of the object.
 
Methods inherited from class com.sas.hls.common.AbstractIdentifiable
equals, getIdentifier, getObjectType, hashCode, setIdentifier, setObjectType
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

OBJECT_TYPE

public static final String OBJECT_TYPE
Represents the type name of a WorkItem object.

See Also:
Constant Field Values
Constructor Detail

WorkItem

@Deprecated
public WorkItem(String identifier,
                           ObjectIdentity context,
                           String contextPath,
                           String name,
                           WorkItem.Status status,
                           List<Attribute> attributes)
Deprecated. Deprecated as of version 1.7. Please use WorkItem(String, ObjectIdentity, String, String, Status, String, List).

Constructor

Parameters:
identifier - the unique identifier of this work item
context - the context where this work item was created
contextPath - the path to the context where this work item was created
name - the name of this work item
status - the status of this work item
attributes - the attributes associated with this work item

WorkItem

public WorkItem(String identifier,
                ObjectIdentity context,
                String contextPath,
                String name,
                WorkItem.Status status,
                String owner,
                List<Attribute> attributes)
Initializing constructor.

Parameters:
identifier - the unique identifier of this work item
context - the context where this work item was created
contextPath - the path to the context where this work item was created
name - the name of this work item
status - the status of this work item
owner - the owner of this work item
attributes - the attributes associated with this work item
Since:
1.7
Method Detail

getContext

public ObjectIdentity getContext()
Get the context for this work item

Returns:
Returns the ObjectIdentity of the context.

getName

public String getName()
Get the name for this work item

Returns:
Returns the name.

getOwner

public String getOwner()
Get the owner for this work item.

Returns:
Returns the owner.
Since:
1.7

getContextPath

public String getContextPath()
Get the path of the context for this work item

Returns:
Returns the context path.

getAttributes

public List<Attribute> getAttributes()
Get the attributes of this work item

Returns:
Returns the attributes

getAttribute

public Attribute getAttribute(String name)
Return the attribute with the provided name.

Parameters:
name - The name of the attribute being requested
Returns:
value The value of the attribute with the provided name, or null if it does not exist.
Since:
1.7

getStatus

public WorkItem.Status getStatus()
Get the status of this work item.

Returns:
Returns the status

toString

public String toString()
Return a string representation of the object.

Overrides:
toString in class Object
See Also:
Object.toString()


Copyright (c) 2014, SAS Institute Inc., Cary, NC, USA