org.dspace.license

Class CCLicenseField

java.lang.Object

org.dspace.license.CCLicenseField

public class CCLicenseField
extends java.lang.Object

Wrapper class for representation of a license field declaration. A license field is a single "question" which must be answered to successfully generate a license.

Constructor Summary

Constructors

Constructor and Description
CCLicenseField(java.lang.String id, java.lang.String label) Construct a new LicenseField class.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescription()
java.util.Map<java.lang.String,java.lang.String>	getEnum()
java.lang.String	getId()
java.lang.String	getLabel()
java.lang.String	getType()
void	setDescription(java.lang.String description)
void	setLabel(java.lang.String label)
void	setType(java.lang.String type)

Methods inherited from class java.lang.Object

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

Constructor Detail

CCLicenseField

public CCLicenseField(java.lang.String id,
              java.lang.String label)

Construct a new LicenseField class. Note that after construction, at least the type should be set.

Parameters:

id - The unique identifier for this field; this value will be used in constructing the answers XML.

label - The label to use when generating the user interface.

Method Detail

getId

public java.lang.String getId()

Returns:

Returns the identifier for this field.

getDescription

public java.lang.String getDescription()

Returns:

Returns the description of the field.

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - The new description; this is often used as a tooltip when generating user interfaces.

getLabel

public java.lang.String getLabel()

Returns:

Returns the label.

setLabel

public void setLabel(java.lang.String label)

Parameters:

label - The label to set.

getType

public java.lang.String getType()

Returns:

Returns the type.

setType

public void setType(java.lang.String type)

Parameters:

type - The type to set.

getEnum

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

Returns:

Returns an instance implementing the Map interface; the instance contains a mapping from identifiers to labels for the enumeration values.

See Also:

Map