Package ch.systemsx.cisd.openbis.dss.generic.shared.api.v1

Class NewDataSetMetadataDTO

java.lang.Object

ch.systemsx.cisd.openbis.dss.generic.shared.api.v1.NewDataSetMetadataDTO

All Implemented Interfaces:

java.io.Serializable

public class NewDataSetMetadataDTO
extends java.lang.Object
implements java.io.Serializable

Represents optional metadata (data set type and properties) of a new data set that the DSS should register. The server may override the metadata specified here.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
NewDataSetMetadataDTO()
NewDataSetMetadataDTO(java.lang.String dataSetTypeOrNull, java.util.Map<java.lang.String,java.lang.String> propertiesOrNull)
NewDataSetMetadataDTO(java.lang.String dataSetTypeOrNull, java.util.Map<java.lang.String,java.lang.String> propertiesOrNull, java.util.List<java.lang.String> parentDataSetCodesOrNull)

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getParentDataSetCodes()	The codes of the parent data sets for this new data set.
java.util.Map<java.lang.String,java.lang.String>	getProperties()	The properties for the new data set.
java.util.Collection<java.lang.String>	getUnmodifiableProperties()	The unmodifiable property types (as strings).
boolean	isUnmodifiableProperty(java.lang.String property)
void	setDataSetTypeOrNull(java.lang.String dataSetTypeOrNull)
void	setParentDataSetCodes(java.util.List<java.lang.String> codesOrNull)	Sets the parent data sets of this data set.
void	setProperties(java.util.Map<java.lang.String,java.lang.String> props)
void	setUnmodifiableProperties(java.util.Map<java.lang.String,java.lang.String> props)
void	setUnmodifiableProperties(java.util.Set<java.lang.String> props)
java.lang.String	toString()
java.lang.String	tryDataSetType()	The code for the type of the new data set.

Methods inherited from class java.lang.Object

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

Constructor Detail

NewDataSetMetadataDTO

public NewDataSetMetadataDTO(java.lang.String dataSetTypeOrNull,
                             java.util.Map<java.lang.String,java.lang.String> propertiesOrNull)

NewDataSetMetadataDTO

public NewDataSetMetadataDTO(java.lang.String dataSetTypeOrNull,
                             java.util.Map<java.lang.String,java.lang.String> propertiesOrNull,
                             java.util.List<java.lang.String> parentDataSetCodesOrNull)

NewDataSetMetadataDTO

public NewDataSetMetadataDTO()

Method Detail

tryDataSetType

public java.lang.String tryDataSetType()

The code for the type of the new data set. May be null.

setDataSetTypeOrNull

public void setDataSetTypeOrNull(java.lang.String dataSetTypeOrNull)

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

The properties for the new data set. Key is the property code, value is the value (as a string).

getUnmodifiableProperties

public java.util.Collection<java.lang.String> getUnmodifiableProperties()

The unmodifiable property types (as strings).

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.String> props)

setUnmodifiableProperties

public void setUnmodifiableProperties(java.util.Set<java.lang.String> props)

setUnmodifiableProperties

public void setUnmodifiableProperties(java.util.Map<java.lang.String,java.lang.String> props)

isUnmodifiableProperty

public boolean isUnmodifiableProperty(java.lang.String property)

getParentDataSetCodes

public java.util.List<java.lang.String> getParentDataSetCodes()

The codes of the parent data sets for this new data set. The list may be empty.

Since:

1.3

setParentDataSetCodes

public void setParentDataSetCodes(java.util.List<java.lang.String> codesOrNull)

Sets the parent data sets of this data set.

Parameters:

codesOrNull - If the value is null, the parents are cleared.

Since:

1.3

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object