Overview Package Class Deprecated Help

clear
ClearRequest

Class that persists clear requests and its result. OSS should NOT use this class directly to create a request, but the application level clear method (e.g. ipipe.Site.requestClearArpCache) on the appropriate domain object to create requests.
The result of requests (which is the result of the actual clear) can be retrieved through the retrieveClearRequest method of the ClearCommandManager. OSS should use the RequestHandleStruct returned by the application level clear method. This RequestHandleStruct can only be obtained from the application level clear method, if and only if the method is invoked synchronously.
It should be noted that ClearRequest are reusable objects and limited resources. Reuse is controlled by each application while the number of requests (for all type of clears) if controlled by a Size constraint policy.

public class ClearRequest

Properties
clearApplication The clear application, e.g. clear ARP cache of service.

type=clear.ClearApplication
access=read-create
Mandatory on create
Displayed(tab/group)=Application
clearParams Params for the clear.

type=string
access=read-only
default=
minimum=0
maximum=1024
Displayed(tab/group)=Parameters
creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual
id Id of the request

type=long
access=read-create
default=0
minimum=1
maximum=2147483647
Displayed(tab/group)=ID
lastStateChange Last time the requestState changed.

type=Time
access=read-only
requestErrorText If requestResult is 'failure' the reason for the failure.

type=string
access=read-only
default=
minimum=0
maximum=255
Displayed(tab/group)=Error Description
requestResult The result of the request.

type=clear.ClearResult
access=read-only
default=success
Displayed(tab/group)=Result
requestState The state of this request

type=clear.ClearRequestState
access=read-only
Displayed(tab/group)=State
requestTime Time when request was created/reused.

type=Date
access=read-only
Displayed(tab/group)=Request Time
requestTimeOut Time when request would time-out.

type=Time
access=read-only
requestor FDN of the requestor

type=Pointer
access=read-only
default=
siteId System IP address of the node.

type=string
access=read-create
default=
maximum=64
Mandatory on create
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed