com.dnanexus

Class DXDataObject.Describe

java.lang.Object

com.dnanexus.DXDataObject.Describe

Direct Known Subclasses:

DXApplet.Describe, DXFile.Describe, DXRecord.Describe, DXWorkflow.Describe

Enclosing class:

DXDataObject

public static class DXDataObject.Describe
extends Object

Contains metadata for a data object (fields common to all data objects). All accessors reflect the state of the data object at the time that this object was created.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Describe() Creates a Describe object with all empty metadata.

Method Summary

Modifier and Type	Method and Description
Date	getCreationDate() Returns the creation date of the object.
<T> T	getDetails(Class<T> valueType) Returns the details of the object.
String	getFolder() Returns the folder that contains the object.
Date	getModificationDate() Returns the last modification date of the object.
String	getName() Returns the name of the object.
DXContainer	getProject() Returns the project or container from which user-provided metadata was retrieved.
Map<String,String>	getProperties() Returns the properties associated with the object.
DataObjectState	getState() Returns the state of the object.
List<String>	getTags() Returns a list of tags associated with the object.
List<String>	getTypes() Returns a list of types associated with the object.
boolean	isVisible() Returns whether the object is visible.

Methods inherited from class java.lang.Object

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

Constructor Detail

Describe

protected Describe()

Creates a Describe object with all empty metadata.

Method Detail

getCreationDate

public Date getCreationDate()

Returns the creation date of the object.

Returns:

creation date

getDetails

public <T> T getDetails(Class<T> valueType)

Returns the details of the object. This field may not be available unless DXDataObject.describe(DescribeOptions) (or DXSearch.FindDataObjectsRequestBuilder.includeDescribeOutput(DXDataObject.DescribeOptions) ) was called with DXDataObject.DescribeOptions.withDetails() set.

Parameters:

valueType - class to deserialize as

Returns:

the object's details

Throws:

IllegalStateException - if details were not retrieved with the describe call

getFolder

public String getFolder()

Returns the folder that contains the object.

Returns:

full path to the containing folder (a String starting with "/")

getModificationDate

public Date getModificationDate()

Returns the last modification date of the object.

Returns:

modification date

getName

public String getName()

Returns the name of the object.

Returns:

the object's name

getProject

public DXContainer getProject()

Returns the project or container from which user-provided metadata was retrieved.

Returns:

DXProject or DXContainer

getProperties

public Map<String,String> getProperties()

Returns the properties associated with the object. This field may not be available unless DXDataObject.describe(DescribeOptions) (or DXSearch.FindDataObjectsRequestBuilder.includeDescribeOutput(DXDataObject.DescribeOptions) ) was called with DXDataObject.DescribeOptions.withProperties() set.

Returns:

Map of property keys to property values

Throws:

IllegalStateException - if properties were not retrieved with the describe call

getState

public DataObjectState getState()

Returns the state of the object.

Returns:

a DXObjectState indicating the current state

getTags

public List<String> getTags()

Returns a list of tags associated with the object.

Returns:

List of tags

getTypes

public List<String> getTypes()

Returns a list of types associated with the object.

Returns:

List of types

isVisible

public boolean isVisible()

Returns whether the object is visible.

Returns:

true if the object is visible