Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Enterprise Scheduler Service
11g Release 1 (11.1.1.6.2)
E26229-03


oracle.as.scheduler.job
Class BatchDeleteProperty

java.lang.Object
  extended by oracle.as.scheduler.job.BatchDeleteProperty


public final class BatchDeleteProperty
extends java.lang.Object

Application properties for BatchDelete request.

Some parameters specify the delete criteria and are used as input to the batch delete job. Such parameters are usually specified as RequestParameters when the delete job is submitted. Other parameters are set by the batch delete job with basic information as to the outcome of the job.

Since:
release specific (what release of product did this appear in)
Version:
$Header: ess/src/oracle/as/scheduler/job/BatchDeleteProperty.java /main/3 2010/08/28 19:31:45 chall Exp $
Author:
chall

Field Summary
static java.lang.String CRITERIA_APPLICATION
          Criteria property that specifies the application for which requests are to be deleted.
static java.lang.String CRITERIA_JOBDEFN
          Criteria property that specifies the string representation of the job/jobset definition metadata id for which requests are to be deleted.
static java.lang.String CRITERIA_JOBEXECTYPE
          Criteria property that specifies the job execution type for which requests are to be deleted.
static java.lang.String CRITERIA_MINIMUM_AGE
          Criteria property that specifies the minimum age, in days, before a request that has completed is eligible for deletion.
static java.lang.String CRITERIA_PROCESS_LIMIT
          Criteria property that specifies the limit on number of requests to be processed by a batch delete request.
static java.lang.String CRITERIA_PRODUCT
          Criteria property that specifies the product for which requests are to be deleted.
static java.lang.String CRITERIA_RETENTION_AGE_CANCEL
          Criteria property that specifies the minimum age, in days, before a request that was cancelled is eligible for deletion.
static java.lang.String CRITERIA_RETENTION_AGE_ERROR
          Criteria property that specifies the minimum age, in days, before a request that completed with an error is eligible for deletion.
static java.lang.String CRITERIA_RETENTION_AGE_SUCCESS
          Criteria property that specifies the minimum age, in days, before a request that completed as success is eligible for deletion.
static java.lang.String CRITERIA_RETENTION_AGE_WARNING
          Criteria property that specifies the minimum age, in days, before a request that completed with an warning is eligible for deletion.
static java.lang.String CRITERIA_SUBMIT_USER
          Criteria property that specifies the submitting user for which requests are to be deleted.
static java.lang.String RESULT_DELETED_COUNT
          Result property that specifies the number of parent requests for which the delete operation succeeded.
static java.lang.String RESULT_FAILED_COUNT
          Result property that specifies the number of parent requests for which the delete operation failed.
static java.lang.String RESULT_PROCESSED_COUNT
          Result property that specifies the number of parent requests processed by the batch delete job.
static java.lang.String RESULT_TOTAL_DELETED
          Result property that specifies the total number of requests that were deleted.

 

Constructor Summary
BatchDeleteProperty()
           

 

Method Summary
static java.util.Collection<java.lang.String> getNames()
          Returns the names of the system properties.
static ParameterInfo getParameterInfo(java.lang.String name)
          Returns the ParameterInfo for the batch delete property identified by the given name.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

CRITERIA_APPLICATION

public static final java.lang.String CRITERIA_APPLICATION
Criteria property that specifies the application for which requests are to be deleted. If null, application is not used as part of the delete criteria.

The property datatype is STRING.

See Also:
Constant Field Values

CRITERIA_PRODUCT

public static final java.lang.String CRITERIA_PRODUCT
Criteria property that specifies the product for which requests are to be deleted. If null, product is not used as part of the delete criteria.

The property datatype is STRING.

See Also:
Constant Field Values

CRITERIA_JOBDEFN

public static final java.lang.String CRITERIA_JOBDEFN
Criteria property that specifies the string representation of the job/jobset definition metadata id for which requests are to be deleted. If null, job definition is not used as part of the delete criteria.

The property datatype is STRING.

See Also:
Constant Field Values

CRITERIA_JOBEXECTYPE

public static final java.lang.String CRITERIA_JOBEXECTYPE
Criteria property that specifies the job execution type for which requests are to be deleted. If null, job execution type is not used as part of the delete criteria.

The property datatype is STRING.

See Also:
Constant Field Values

CRITERIA_SUBMIT_USER

public static final java.lang.String CRITERIA_SUBMIT_USER
Criteria property that specifies the submitting user for which requests are to be deleted. If null, submitting user is not used as part of the delete criteria.

The property datatype is STRING.

See Also:
Constant Field Values

CRITERIA_MINIMUM_AGE

public static final java.lang.String CRITERIA_MINIMUM_AGE
Criteria property that specifies the minimum age, in days, before a request that has completed is eligible for deletion.

The property datatype is INTEGER.

See Also:
Constant Field Values

CRITERIA_RETENTION_AGE_SUCCESS

public static final java.lang.String CRITERIA_RETENTION_AGE_SUCCESS
Criteria property that specifies the minimum age, in days, before a request that completed as success is eligible for deletion. If null, the value of CRITERIA_MINIMUM_AGE will be used.

The property datatype is INTEGER.

See Also:
Constant Field Values

CRITERIA_RETENTION_AGE_ERROR

public static final java.lang.String CRITERIA_RETENTION_AGE_ERROR
Criteria property that specifies the minimum age, in days, before a request that completed with an error is eligible for deletion. If null, the value of CRITERIA_MINIMUM_AGE will be used.

The property datatype is INTEGER.

See Also:
Constant Field Values

CRITERIA_RETENTION_AGE_WARNING

public static final java.lang.String CRITERIA_RETENTION_AGE_WARNING
Criteria property that specifies the minimum age, in days, before a request that completed with an warning is eligible for deletion. If null, the value of CRITERIA_MINIMUM_AGE will be used.

The property datatype is INTEGER.

See Also:
Constant Field Values

CRITERIA_RETENTION_AGE_CANCEL

public static final java.lang.String CRITERIA_RETENTION_AGE_CANCEL
Criteria property that specifies the minimum age, in days, before a request that was cancelled is eligible for deletion. If null, the value of CRITERIA_MINIMUM_AGE will be used.

The property datatype is INTEGER.

See Also:
Constant Field Values

CRITERIA_PROCESS_LIMIT

public static final java.lang.String CRITERIA_PROCESS_LIMIT
Criteria property that specifies the limit on number of requests to be processed by a batch delete request. There is no limit if the value is zero or null.

This represents a limit on the number of instance parent requests and does not include any child requests of those parents.

The property datatype is LONG.

See Also:
Constant Field Values

RESULT_PROCESSED_COUNT

public static final java.lang.String RESULT_PROCESSED_COUNT
Result property that specifies the number of parent requests processed by the batch delete job. This represents the number of parent requests for which the operation succeeded plus the number of parent requests for which the operation failed. Child requests are not included.

This parameter is updated during the execution of the batch delete job.

The property datatype is LONG.

See Also:
Constant Field Values

RESULT_DELETED_COUNT

public static final java.lang.String RESULT_DELETED_COUNT
Result property that specifies the number of parent requests for which the delete operation succeeded. Child requests are not included.

This parameter is updated during the execution of the batch delete job.

The property datatype is LONG.

See Also:
Constant Field Values

RESULT_FAILED_COUNT

public static final java.lang.String RESULT_FAILED_COUNT
Result property that specifies the number of parent requests for which the delete operation failed. Child requests are not included.

This parameter is updated during the execution of the batch delete job.

The property datatype is LONG.

See Also:
Constant Field Values

RESULT_TOTAL_DELETED

public static final java.lang.String RESULT_TOTAL_DELETED
Result property that specifies the total number of requests that were deleted. This represents the total number of parent requests plus child requests that were deleted.

This parameter is updated during the execution of the batch delete job.

The property datatype is LONG.

See Also:
Constant Field Values

Constructor Detail

BatchDeleteProperty

public BatchDeleteProperty()

Method Detail

getNames

public static java.util.Collection<java.lang.String> getNames()
Returns the names of the system properties.
Returns:
a collection of the property names.

getParameterInfo

public static ParameterInfo getParameterInfo(java.lang.String name)
Returns the ParameterInfo for the batch delete property identified by the given name.
Parameters:
name - the name of the batch delete property. If null, this method returns null.
Returns:
the information about the property. This will be null if name is not a delete property.

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Enterprise Scheduler Service
11g Release 1 (11.1.1.6.2)
E26229-03


Copyright © 2008, 2012 Oracle. All rights reserved.