com.oakgrovesystems.reactor.requests
Class Lock
java.lang.Object
|
+--com.oakgrovesystems.reactor.requests.ReactorRequest
|
+--com.oakgrovesystems.reactor.requests.LockingBase
|
+--com.oakgrovesystems.reactor.requests.Lock
- All Implemented Interfaces:
- java.io.Serializable
- public class Lock
- extends LockingBase
This request attempts to atomically test and set an ACE in the
specified object, and optionally perform some related actions
at the same time. If the eligible
ACE role is set,
then the user requesting the lock must have that ACE role. If
the standby
ACE role is set, then all the ACEs
having the eligible
ACE role will be switched to
having the standby
ACE role. This is useful when
an activity is assigned to multiple people, but only one person
can work on the activity at a time. If the status
is set, then the specified status will be added to the object
(if the object is a process) or the object's associated process
(if the object is not a process).
Both Lock and Unlock handle parameters by extending the LockingBase class.
- See Also:
- Serialized Form
Field Summary |
static java.lang.String |
REQUEST_TYPE
The request type of Lock requests. |
Constructor Summary |
Lock()
Creates a Lock request without specifying the authentication
token to use to make the request. |
Lock(java.lang.String authToken)
Creates a Lock request that will use the specified authentication token |
Method Summary |
protected com.oakgrovesystems.reactor.ReactorResponse |
parseReturnValues(org.jdom.Element returnValues)
|
Methods inherited from class com.oakgrovesystems.reactor.requests.LockingBase |
getEligibleRole, getLockACE, getObjectId, getObjectLabelPath, getStandbyRole, getStatusId, getStatusLabelPath, paramsToXML, parseParameters, setEligibleRole, setLockACE, setObjectId, setObjectLabelPath, setStandbyRole, setStatusId, setStatusLabelPath |
Methods inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest |
configureFromXML, configureFromXML, createResponseXML, createResponseXML, createReturnValuesElem, createRtnValXML, getAuthToken, getLabelPath, getObjectId, getParameter, getParameter, getParameterNames, getRequestType, makeAuthTokenXML, makeObjectElement, makeOperandElement, makePolicyElement, makeProcessElement, makeReferenceElement, makeStatusElement, parseResponse, send, sendAsXML, sendViaHttp, setAuthToken, setParameter, setRequestType, toString, toXML |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
REQUEST_TYPE
public static final java.lang.String REQUEST_TYPE
- The request type of Lock requests. Used as a parameter to
setRequestType() in the instance initializer.
- See Also:
- Constant Field Values
Lock
public Lock()
- Creates a Lock request without specifying the authentication
token to use to make the request. setAuthToken() must be called
before the request can be sent successfully.
Lock
public Lock(java.lang.String authToken)
- Creates a Lock request that will use the specified authentication token
- Parameters:
authToken
- the authentication token to use to make the request
parseReturnValues
protected com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues)
throws FailedRequestException
- Specified by:
parseReturnValues
in class ReactorRequest
FailedRequestException
Copyright (c) 1999-2004 Oak Grove Systems. All Rights Reserved.