com.unboundid.ldap.sdk.unboundidds.tasks
Class TaskProperty

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.tasks.TaskProperty
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class TaskProperty
extends java.lang.Object
implements java.io.Serializable

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides information about a property that may be used to schedule a task. Elements of a task property include:

See Also:
Serialized Form

Constructor Summary
TaskProperty(java.lang.String attributeName, java.lang.String displayName, java.lang.String description, java.lang.Class<?> dataType, boolean required, boolean multiValued, boolean advanced)
          Creates a new task property with the provided information.
TaskProperty(java.lang.String attributeName, java.lang.String displayName, java.lang.String description, java.lang.Class<?> dataType, boolean required, boolean multiValued, boolean advanced, java.lang.Object[] allowedValues)
          Creates a new task property with the provided information.
 
Method Summary
 java.lang.Object[] getAllowedValues()
          Retrieves the set of values that may be used for this task property.
 java.lang.String getAttributeName()
          Retrieves the name of the LDAP attribute associated with this task property.
 java.lang.Class<?> getDataType()
          Retrieves the data type for this task property, which represents the expected data type for the value(s) of this property.
 java.lang.String getDescription()
          Retrieves the human-readable description for this task property.
 java.lang.String getDisplayName()
          Retrieves the human-readable display name for this task property.
 boolean isAdvanced()
          Indicates whether this task property is considered advanced.
 boolean isMultiValued()
          Indicates whether this task property is allowed to have multiple values.
 boolean isRequired()
          Indicates whether this task property is required to be provided in order to schedule a task.
 java.lang.String toString()
          Retrieves a string representation of this task property.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this task property to the provided buffer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TaskProperty

public TaskProperty(java.lang.String attributeName,
                    java.lang.String displayName,
                    java.lang.String description,
                    java.lang.Class<?> dataType,
                    boolean required,
                    boolean multiValued,
                    boolean advanced)
Creates a new task property with the provided information.

Parameters:
attributeName - The name of the LDAP attribute associated with this task property. It must not be null.
displayName - The human-readable display name for this task property. It must not be null.
description - The human-readable description for this task property. It must not be null.
dataType - A class representing the data type for this property. Allowed data type classes include: Boolean, Date, Long, and String. It must not be null.
required - Indicates whether this property must be provided when scheduling a task.
multiValued - Indicates whether this property is allowed to have multiple values.
advanced - Indicates whether this property may be considered advanced and doesn't necessarily need to be presented to the user. Advanced properties must not be required.

TaskProperty

public TaskProperty(java.lang.String attributeName,
                    java.lang.String displayName,
                    java.lang.String description,
                    java.lang.Class<?> dataType,
                    boolean required,
                    boolean multiValued,
                    boolean advanced,
                    java.lang.Object[] allowedValues)
Creates a new task property with the provided information.

Parameters:
attributeName - The name of the LDAP attribute associated with this task property. It must not be null.
displayName - The human-readable display name for this task property. It must not be null.
description - The human-readable description for this task property. It must not be null.
dataType - A class representing the data type for this property. Allowed data type classes include: Boolean, Date, Long, and String. It must not be null.
required - Indicates whether this property must be provided when scheduling a task.
multiValued - Indicates whether this property is allowed to have multiple values.
advanced - Indicates whether this property may be considered advanced and doesn't necessarily need to be presented to the user. Advanced properties must not be required.
allowedValues - The set of allowed values for this task property. It may be null if there is not a predefined set of acceptable values. If it is provided, then all values must be objects of the class specified as the data type.
Method Detail

getAttributeName

public java.lang.String getAttributeName()
Retrieves the name of the LDAP attribute associated with this task property.

Returns:
The name of the LDAP attribute associated with this task property.

getDisplayName

public java.lang.String getDisplayName()
Retrieves the human-readable display name for this task property.

Returns:
The human-readable display name for this task property.

getDescription

public java.lang.String getDescription()
Retrieves the human-readable description for this task property.

Returns:
The human-readable description for this task property.

getDataType

public java.lang.Class<?> getDataType()
Retrieves the data type for this task property, which represents the expected data type for the value(s) of this property. Supported data types include Boolean, Date, Long, and String.

Returns:
The data type for this task property.

isRequired

public boolean isRequired()
Indicates whether this task property is required to be provided in order to schedule a task.

Returns:
true if this task property is required, or false if it is not.

isMultiValued

public boolean isMultiValued()
Indicates whether this task property is allowed to have multiple values.

Returns:
true if this task property is allowed to have multiple values, or false if it may only have a single value.

isAdvanced

public boolean isAdvanced()
Indicates whether this task property is considered advanced. Advanced properties are not necessarily required to schedule the task and may be hidden from the user if simplicity is desired over flexibility.

Returns:
true if this task property is considered advanced, or false if not.

getAllowedValues

public java.lang.Object[] getAllowedValues()
Retrieves the set of values that may be used for this task property.

Returns:
The set of values that may be used for this task property, or null if there is not a predefined set of allowed values.

toString

public java.lang.String toString()
Retrieves a string representation of this task property.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this task property.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this task property to the provided buffer.

Parameters:
buffer - The buffer to which the string representation should be appended.