Class RemoveAttributeTypeTaskProperties

  • All Implemented Interfaces:
    java.io.Serializable

    @Mutable
    @ThreadSafety(level=NOT_THREADSAFE)
    public final class RemoveAttributeTypeTaskProperties
    extends java.lang.Object
    implements java.io.Serializable
    This class defines a set of properties that may be used when creating a RemoveAttributeTypeTask.
    NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Boolean getAlertOnError()
      Retrieves the flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully.
      java.lang.Boolean getAlertOnStart()
      Retrieves the flag that indicates whether the server should send an administrative alert notification when the task starts running.
      java.lang.Boolean getAlertOnSuccess()
      Retrieves the flag that indicates whether the server should send an administrative alert notification if the task completes successfully.
      java.lang.String getAttributeType()
      Retrieves the name or OID of the attribute type to remove from the server schema.
      java.util.List<java.lang.String> getDependencyIDs()
      Retrieves the task IDs for any tasks that must complete before the new remove attribute type task will be eligible to start running.
      FailedDependencyAction getFailedDependencyAction()
      Retrieves the action that the server should take if any of the tasks on which the new task depends did not complete successfully.
      java.util.List<java.lang.String> getNotifyOnCompletion()
      Retrieves the addresses to email whenever the task completes, regardless of its success or failure.
      java.util.List<java.lang.String> getNotifyOnError()
      Retrieves the addresses to email if the task does not complete successfully.
      java.util.List<java.lang.String> getNotifyOnStart()
      Retrieves the addresses to email whenever the task starts running.
      java.util.List<java.lang.String> getNotifyOnSuccess()
      Retrieves the addresses to email if the task completes successfully.
      java.util.Date getScheduledStartTime()
      Retrieves the earliest time that the task should be eligible to start running.
      java.lang.String getTaskID()
      Retrieves the task ID that should be used for the task.
      void setAlertOnError​(java.lang.Boolean alertOnError)
      Specifies the flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully.
      void setAlertOnStart​(java.lang.Boolean alertOnStart)
      Specifies the flag that indicates whether the server should send an administrative alert notification when the task starts running.
      void setAlertOnSuccess​(java.lang.Boolean alertOnSuccess)
      Specifies the flag that indicates whether the server should send an administrative alert notification if the task completes successfully.
      void setAttributeType​(java.lang.String attributeType)
      Specifies the name or OID of the attribute type to remove from the server schema.
      void setDependencyIDs​(java.util.List<java.lang.String> dependencyIDs)
      Specifies the task IDs for any tasks that must complete before the new remove attribute type task will be eligible to start running.
      void setFailedDependencyAction​(FailedDependencyAction failedDependencyAction)
      Specifies the action that the server should take if any of the tasks on which the new task depends did not complete successfully.
      void setNotifyOnCompletion​(java.util.List<java.lang.String> notifyOnCompletion)
      Specifies the addresses to email whenever the task completes, regardless of its success or failure.
      void setNotifyOnError​(java.util.List<java.lang.String> notifyOnError)
      Specifies the addresses to email if the task does not complete successfully.
      void setNotifyOnStart​(java.util.List<java.lang.String> notifyOnStart)
      Specifies the addresses to email whenever the task starts running.
      void setNotifyOnSuccess​(java.util.List<java.lang.String> notifyOnSuccess)
      Specifies the addresses to email if the task completes successfully.
      void setScheduledStartTime​(java.util.Date scheduledStartTime)
      Specifies the earliest time that the task should be eligible to start running.
      void setTaskID​(java.lang.String taskID)
      Specifies the task ID that should be used for the task.
      java.lang.String toString()
      Retrieves a string representation of this remove attribute type task properties object.
      void toString​(java.lang.StringBuilder buffer)
      Appends a string representation of this remove attribute type task properties object to the provided buffer.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • RemoveAttributeTypeTaskProperties

        public RemoveAttributeTypeTaskProperties​(@NotNull
                                                 java.lang.String attributeType)
        Creates a new set of remove attribute type task properties. It will use default values for all general task properties.
        Parameters:
        attributeType - The name or OID of the attribute type to remove from the server schema.
    • Method Detail

      • getAttributeType

        @NotNull
        public java.lang.String getAttributeType()
        Retrieves the name or OID of the attribute type to remove from the server schema.
        Returns:
        The name or OID of the attribute type to remove from the server schema.
      • setAttributeType

        public void setAttributeType​(@NotNull
                                     java.lang.String attributeType)
        Specifies the name or OID of the attribute type to remove from the server schema.
        Parameters:
        attributeType - The name or OID of the attribute type to remove from the server schema.
      • getTaskID

        @Nullable
        public java.lang.String getTaskID()
        Retrieves the task ID that should be used for the task.
        Returns:
        The task ID that should be used for the task, or null if a random UUID should be generated for use as the task ID.
      • setTaskID

        public void setTaskID​(@Nullable
                              java.lang.String taskID)
        Specifies the task ID that should be used for the task.
        Parameters:
        taskID - The task ID that should be used for the task. It may be null if a random UUID should be generated for use as the task ID.
      • getScheduledStartTime

        @Nullable
        public java.util.Date getScheduledStartTime()
        Retrieves the earliest time that the task should be eligible to start running.
        Returns:
        The earliest time that the task should be eligible to start running, or null if the task should be eligible to start immediately (or as soon as all of its dependencies have been satisfied).
      • setScheduledStartTime

        public void setScheduledStartTime​(@Nullable
                                          java.util.Date scheduledStartTime)
        Specifies the earliest time that the task should be eligible to start running.
        Parameters:
        scheduledStartTime - The earliest time that the task should be eligible to start running. It may be null if the task should be eligible to start immediately (or as soon as all of its dependencies have been satisfied).
      • getDependencyIDs

        @NotNull
        public java.util.List<java.lang.String> getDependencyIDs()
        Retrieves the task IDs for any tasks that must complete before the new remove attribute type task will be eligible to start running.
        Returns:
        The task IDs for any tasks that must complete before the new remove attribute type task will be eligible to start running, or an empty list if the new task should not depend on any other tasks.
      • setDependencyIDs

        public void setDependencyIDs​(@Nullable
                                     java.util.List<java.lang.String> dependencyIDs)
        Specifies the task IDs for any tasks that must complete before the new remove attribute type task will be eligible to start running.
        Parameters:
        dependencyIDs - The task IDs for any tasks that must complete before the new remove attribute type task will be eligible to start running. It may be null or empty if the new task should not depend on any other tasks.
      • getFailedDependencyAction

        @Nullable
        public FailedDependencyAction getFailedDependencyAction()
        Retrieves the action that the server should take if any of the tasks on which the new task depends did not complete successfully.
        Returns:
        The action that the server should take if any of the tasks on which the new task depends did not complete successfully, or null if the property should not be specified when creating the task (and the server should choose an appropriate failed dependency action).
      • setFailedDependencyAction

        public void setFailedDependencyAction​(@Nullable
                                              FailedDependencyAction failedDependencyAction)
        Specifies the action that the server should take if any of the tasks on which the new task depends did not complete successfully.
        Parameters:
        failedDependencyAction - The action that the server should take if any of the tasks on which the new task depends did not complete successfully. It may be null if the property should not be specified when creating the task (and the server should choose an appropriate failed dependency action).
      • getNotifyOnStart

        @NotNull
        public java.util.List<java.lang.String> getNotifyOnStart()
        Retrieves the addresses to email whenever the task starts running.
        Returns:
        The addresses to email whenever the task starts running, or an empty list if no email notification should be sent when starting the task.
      • setNotifyOnStart

        public void setNotifyOnStart​(@Nullable
                                     java.util.List<java.lang.String> notifyOnStart)
        Specifies the addresses to email whenever the task starts running.
        Parameters:
        notifyOnStart - The addresses to email whenever the task starts running. It amy be null or empty if no email notification should be sent when starting the task.
      • getNotifyOnCompletion

        @NotNull
        public java.util.List<java.lang.String> getNotifyOnCompletion()
        Retrieves the addresses to email whenever the task completes, regardless of its success or failure.
        Returns:
        The addresses to email whenever the task completes, or an empty list if no email notification should be sent when the task completes.
      • setNotifyOnCompletion

        public void setNotifyOnCompletion​(@Nullable
                                          java.util.List<java.lang.String> notifyOnCompletion)
        Specifies the addresses to email whenever the task completes, regardless of its success or failure.
        Parameters:
        notifyOnCompletion - The addresses to email whenever the task completes. It amy be null or empty if no email notification should be sent when the task completes.
      • getNotifyOnSuccess

        @NotNull
        public java.util.List<java.lang.String> getNotifyOnSuccess()
        Retrieves the addresses to email if the task completes successfully.
        Returns:
        The addresses to email if the task completes successfully, or an empty list if no email notification should be sent on successful completion.
      • setNotifyOnSuccess

        public void setNotifyOnSuccess​(@Nullable
                                       java.util.List<java.lang.String> notifyOnSuccess)
        Specifies the addresses to email if the task completes successfully.
        Parameters:
        notifyOnSuccess - The addresses to email if the task completes successfully. It amy be null or empty if no email notification should be sent on successful completion.
      • getNotifyOnError

        @NotNull
        public java.util.List<java.lang.String> getNotifyOnError()
        Retrieves the addresses to email if the task does not complete successfully.
        Returns:
        The addresses to email if the task does not complete successfully, or an empty list if no email notification should be sent on an unsuccessful completion.
      • setNotifyOnError

        public void setNotifyOnError​(@Nullable
                                     java.util.List<java.lang.String> notifyOnError)
        Specifies the addresses to email if the task does not complete successfully.
        Parameters:
        notifyOnError - The addresses to email if the task does not complete successfully. It amy be null or empty if no email notification should be sent on an unsuccessful completion.
      • getAlertOnStart

        @Nullable
        public java.lang.Boolean getAlertOnStart()
        Retrieves the flag that indicates whether the server should send an administrative alert notification when the task starts running.
        Returns:
        The flag that indicates whether the server should send an administrative alert notification when the task starts running, or null if the property should not be specified when the task is created (and the server will default to not sending any alert).
      • setAlertOnStart

        public void setAlertOnStart​(@Nullable
                                    java.lang.Boolean alertOnStart)
        Specifies the flag that indicates whether the server should send an administrative alert notification when the task starts running.
        Parameters:
        alertOnStart - The flag that indicates whether the server should send an administrative alert notification when the task starts running, It may be null if the property should not be specified when the task is created (and the server will default to not sending any alert).
      • getAlertOnSuccess

        @Nullable
        public java.lang.Boolean getAlertOnSuccess()
        Retrieves the flag that indicates whether the server should send an administrative alert notification if the task completes successfully.
        Returns:
        The flag that indicates whether the server should send an administrative alert notification if the task completes successfully, or null if the property should not be specified when the task is created (and the server will default to not sending any alert).
      • setAlertOnSuccess

        public void setAlertOnSuccess​(@Nullable
                                      java.lang.Boolean alertOnSuccess)
        Specifies the flag that indicates whether the server should send an administrative alert notification if the task completes successfully.
        Parameters:
        alertOnSuccess - The flag that indicates whether the server should send an administrative alert notification if the task completes successfully, It may be null if the property should not be specified when the task is created (and the server will default to not sending any alert).
      • getAlertOnError

        @Nullable
        public java.lang.Boolean getAlertOnError()
        Retrieves the flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully.
        Returns:
        The flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully, or null if the property should not be specified when the task is created (and the server will default to not sending any alert).
      • setAlertOnError

        public void setAlertOnError​(@Nullable
                                    java.lang.Boolean alertOnError)
        Specifies the flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully.
        Parameters:
        alertOnError - The flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully, It may be null if the property should not be specified when the task is created (and the server will default to not sending any alert).
      • toString

        @NotNull
        public java.lang.String toString()
        Retrieves a string representation of this remove attribute type task properties object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this remove attribute type task properties object.
      • toString

        public void toString​(@NotNull
                             java.lang.StringBuilder buffer)
        Appends a string representation of this remove attribute type task properties object to the provided buffer.
        Parameters:
        buffer - The buffer to which the string representation will be appended. It must not be null.