com.pega.pegarules.pub.reqres

Class RequestIN<T>

java.lang.Object

com.pega.pegarules.pub.reqres.RequestIN<T>

Type Parameters:

T - the generic type

Direct Known Subclasses:

GenerateDDLRequest, HotFixRequest, ManageTrackedDataRequest, RequestSTOP

public abstract class RequestIN<T>
extends java.lang.Object

 The Class RequestIN is the input entity that can be used CLI,UI and Service interfaces.
 
 

 Any operation that needs to be performed from CLI and Service can extend this class.

 

 Any new operation that needs to be performed can be added below in the RequestIN.RequestType enum.

 
 

 The corresponding request and response objects needs to be added in the ProcessorFactory

 

 {com.pega.pegarules.deploy.internal.processors.factory.ProcessorFactory#getRequest}

 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestIN.CallerType
static class	RequestIN.RequestType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
RequestIN()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	get(java.lang.String key)
RequestIN.CallerType	getCallerType()
Database	getEngineDatabase()
java.lang.String	getJobID()
ClipboardPage	getLogPage()
com.pega.pegarules.priv.rulemgmt.MgmtLog	getMoveLog()
PRThread	getPRThread()
java.util.List<T>	getQueryObjects()
RequestIN.RequestType	getRequestType()
PRRequestor.RequestorType	getRunWithRequestor()
boolean	isFirstRequest()
boolean	isLastRequest()
void	set(java.lang.String key, java.lang.Object value) Any additional parameters that needs to be added can added in the below place holder.
void	setCallerType(RequestIN.CallerType callerType) Sets the caller type.
void	setEngineDatabase(Database engineDatabase)
void	setFirstRequest(boolean isFirstRequest) Set this flag if the request is first request.
void	setJobID(java.lang.String jobID)
void	setLastRequest(boolean isLastRequest)
void	setLogPage(ClipboardPage logPage)
void	setMoveLog(com.pega.pegarules.priv.rulemgmt.MgmtLog moveLog) Set the move log so that the returned object can have complete log that was written.
void	setPersistMoveLog(boolean persistMoveLog) Set the log if the moveLog needs to be persisted into database.
void	setPRThread(PRThread prThread)
void	setQueryObjects(java.util.List<T> queryObjects)
void	setRequestType(RequestIN.RequestType requestType) Sets the request type.RequestIN.RequestType
void	setRunWithRequestor(PRRequestor.RequestorType requestorType)
void	setSendRequestBackInResponse(boolean sendRequestBackInResponse) Set the flag if the request needs to send back in the response.
void	setThrowExceptionBack(boolean throwExceptionBack) Set the flag if the exception needs to be thrown back to the caller.
boolean	shouldPersistMoveLog() Checks if is persist move log.
boolean	shouldSendRequestBackInResponse() Checks if is throw exception back.
boolean	shouldThrowExceptionBack() Checks if is throw exception back.
java.lang.String	switchAccessGroup()
void	switchAccessGroup(java.lang.String switchAccessGroup)
abstract void	validate() The validate method needs to be overridden by subclass to perform the validations.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final java.lang.String VERSION

Constructor Detail

RequestIN

public RequestIN()

Method Detail

get

public final java.lang.Object get(java.lang.String key)

set

public final void set(java.lang.String key,
                      java.lang.Object value)

Any additional parameters that needs to be added can added in the below place holder.

Parameters:

key -

value -

getRunWithRequestor

public final PRRequestor.RequestorType getRunWithRequestor()

setRunWithRequestor

public final void setRunWithRequestor(PRRequestor.RequestorType requestorType)

isLastRequest

public final boolean isLastRequest()

setLastRequest

public final void setLastRequest(boolean isLastRequest)

isFirstRequest

public final boolean isFirstRequest()

setFirstRequest

public final void setFirstRequest(boolean isFirstRequest)

Set this flag if the request is first request.

Parameters:

isFirstRequest - the new first request

getRequestType

public final RequestIN.RequestType getRequestType()

setRequestType

public final void setRequestType(RequestIN.RequestType requestType)

Sets the request type.RequestIN.RequestType

Parameters:

requestType - the new request type

getCallerType

public final RequestIN.CallerType getCallerType()

setCallerType

public final void setCallerType(RequestIN.CallerType callerType)

Sets the caller type. RequestIN.CallerType

Parameters:

callerType - the new caller type

getEngineDatabase

public final Database getEngineDatabase()

getPRThread

public final PRThread getPRThread()

setPRThread

public final void setPRThread(PRThread prThread)

getMoveLog

public final com.pega.pegarules.priv.rulemgmt.MgmtLog getMoveLog()

setEngineDatabase

public final void setEngineDatabase(Database engineDatabase)

getQueryObjects

public final java.util.List<T> getQueryObjects()

setMoveLog

public final void setMoveLog(com.pega.pegarules.priv.rulemgmt.MgmtLog moveLog)

Set the move log so that the returned object can have complete log that was written. If this moveLog was not set while creating request then moveLog will be created automatically (AbstractBaseProcessor#createMoveLogIfNotExists)

Parameters:

moveLog - the new move log

setQueryObjects

public final void setQueryObjects(java.util.List<T> queryObjects)

getLogPage

public final ClipboardPage getLogPage()

setLogPage

public final void setLogPage(ClipboardPage logPage)

shouldPersistMoveLog

public final boolean shouldPersistMoveLog()

Checks if is persist move log.

Returns:

true, if is persist move log

setPersistMoveLog

public final void setPersistMoveLog(boolean persistMoveLog)

Set the log if the moveLog needs to be persisted into database.

Parameters:

persistMoveLog - the new persist move log

shouldThrowExceptionBack

public final boolean shouldThrowExceptionBack()

Checks if is throw exception back.

Returns:

true, if is throw exception back

setThrowExceptionBack

public final void setThrowExceptionBack(boolean throwExceptionBack)

Set the flag if the exception needs to be thrown back to the caller. If this flag was true then the exception will be thrown back to caller. if this flag was false then the exception will not be thrown and received via ResponseOUT.getErrorMessages() (Or) ResponseOUT.getErrorList(String)

Parameters:

throwExceptionBack - the new throw exception back

shouldSendRequestBackInResponse

public final boolean shouldSendRequestBackInResponse()

Checks if is throw exception back.

Returns:

true, if is throw exception back

setSendRequestBackInResponse

public final void setSendRequestBackInResponse(boolean sendRequestBackInResponse)

Set the flag if the request needs to send back in the response.

Parameters:

sendRequestBackInResponse - the new throw exception back

getJobID

public java.lang.String getJobID()

setJobID

public void setJobID(java.lang.String jobID)

switchAccessGroup

public java.lang.String switchAccessGroup()

switchAccessGroup

public void switchAccessGroup(java.lang.String switchAccessGroup)

validate

public abstract void validate()
                       throws PRException

The validate method needs to be overridden by subclass to perform the validations.

Throws:

PRException - the PR exception