Class BatchToken
- java.lang.Object
-
- org.identityconnectors.framework.common.objects.BatchToken
-
public class BatchToken extends java.lang.Object
Encapsulates zero or more tokens resulting from submission of a set of batched operations to an external resource via a connector. tokens is a List of Strings representing the tokens used by the resource (or generated by the connector if the resource does not use tokens). These tokens are opaque to the application. If a follow-up queryBatch() call is required to fetch the results of an executeBatch() or additional results following another queryBatch() then this BatchToken should contain queryRequired == true. If false then the application need not issue another queryBatch() command; All results are returned with the command that returned this BatchToken. If results will be returned asynchronous to the return of this BatchToken then asynchronousResults should be true. If false then the expectation is that this BatchToken represents the final data returned by the connector.
-
-
Constructor Summary
Constructors Constructor Description BatchToken()
BatchToken(java.lang.String token)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addToken(java.lang.String token)
java.util.List<java.lang.String>
getTokens()
boolean
hasAsynchronousResults()
boolean
hasToken(java.lang.String token)
boolean
isQueryRequired()
void
removeToken(java.lang.String token)
boolean
returnsResults()
void
setAsynchronousResults(boolean asynchronousResults)
void
setQueryRequired(boolean queryRequired)
void
setReturnsResults(boolean returnsResults)
-
-
-
Method Detail
-
addToken
public void addToken(java.lang.String token)
-
removeToken
public void removeToken(java.lang.String token)
-
getTokens
public java.util.List<java.lang.String> getTokens()
-
hasToken
public boolean hasToken(java.lang.String token)
-
isQueryRequired
public boolean isQueryRequired()
-
setQueryRequired
public void setQueryRequired(boolean queryRequired)
-
hasAsynchronousResults
public boolean hasAsynchronousResults()
-
setAsynchronousResults
public void setAsynchronousResults(boolean asynchronousResults)
-
returnsResults
public boolean returnsResults()
-
setReturnsResults
public void setReturnsResults(boolean returnsResults)
-
-