public interface IStep
IStep
represents a step in the approval workflow.
The workflow can consist of several steps, and each step can have
several approvers.
It is used in the user interface to define and display the
workflow for a resource. IStepList
Modifier and Type | Method and Description |
---|---|
void |
addApprover(IApprover impApprover)
Adds one approver to the step.
|
boolean |
appendApproverStringToStep(String impApproverString)
Adds one approver to the step by using a string from the list which is returned by
getApproverStringsOfStep()
The list which is returned by getApproverStringsOfStep()
contains strings, each of which represents a single approver entry assigned to the step. |
boolean |
containsApprover(com.sapportals.portal.security.usermanagement.IUser impUser)
Deprecated.
As of NetWeaver 7.1, replaced by
containsApprover(com.sap.security.api.IUser) |
boolean |
containsApprover(IUser impUser)
Checks whether a
IUser is contained in the approver list of the step. |
List |
deleteSelectedApprovers()
Removes the selected approvers.
|
List |
getApproverOfStep()
Returns a list of approvers for one step.
|
List |
getApproverStringsOfStep()
Returns a list of strings representing the approvers of the step.
|
String |
getDisplayName()
Returns a description of the
Step . |
boolean |
isEmpty()
Checks whether approvers are assigned to the step.
|
boolean |
isSelected()
Checks whether the step has been selected.
|
void |
setDisplayName(String impName)
Sets a description for the
Step . |
void |
setSelected(boolean impSelected)
Sets the selected flag.
|
void addApprover(IApprover impApprover)
impApprover
is added to the current step. Duplicate
entries are prevented, which means that the approver is only added, if there
is no other IApprover
that equals the imApprover
already assigend to the step.impApprover
- the approver to be added to the listboolean isSelected()
boolean isEmpty()
IStepList
before the steplist can be used.void setSelected(boolean impSelected)
impSelected
- Boolean flag to select or deselect the stepString getDisplayName()
Step
.
A step can have a meaningful name to be displayed in the user
interface.void setDisplayName(String impName)
Step
.
A step can have a meaningful name to be displayed in the user
interface.impName
- display name of the stepList getApproverOfStep()
List
returned contains only IApprover
objects.IApprover
objectsIApprover
List getApproverStringsOfStep()
IStep
into a list of string values. The IStep
can be deserialized using the appendApproverStringToStep
for each element contained in the List
returned by this method. IApprovers
IApprover
boolean appendApproverStringToStep(String impApproverString) throws WcmException
getApproverStringsOfStep()
The list which is returned by getApproverStringsOfStep()
contains strings, each of which represents a single approver entry assigned to the step.
The name of the step is also encoded in each string.
This method checks if the name of the step in the string matches the name
of the current step, and returns false if it does not match.impApproverString
- string for a single approver within the stepWcmException
- exception raised in failure situationList deleteSelectedApprovers()
IApprovers
that are removed is returned.IApprovers
- WcmException
boolean containsApprover(com.sapportals.portal.security.usermanagement.IUser impUser)
containsApprover(com.sap.security.api.IUser)
IUser
is contained in the approver list of the step.
An approver can be a single user, or a group or role.
This method checks all approvers assigned to this step. If the approver is a group or
role, the method checks if the user is contained in this group or role.impUser
- user that is checkedIApprover
boolean containsApprover(IUser impUser)
IUser
is contained in the approver list of the step.
An approver can be a single user, or a group or role.
This method checks all approvers assigned to this step. If the approver is a group or
role, the method checks if the user is contained in this group or role.impUser
- user that is checkedIApprover
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice