public interface UnpublishFromPortalAction extends CSOAction
Modifier and Type | Method and Description |
---|---|
java.util.Collection<APIPortal> |
getApplicableApiPortals()
Returns the
Collection of APIPortal objects that are accessible by the current logged in user for unpublish. |
java.util.Collection<APIPortal> |
getRegisteredApiPortals()
Returns the
Collection of APIPortal objects which are registered with CentraSite. |
java.lang.String |
getUnpublishReport()
This returns a JSON string which explains the unpublish status.
|
java.lang.String |
getUnublishResultString()
Returns a string which sums up the result of unpublishinig the selected APIs from the Portals.
|
void |
setSelectedApiPortals(java.util.Collection<APIPortal> selectedPortals)
Sets the
Collection of APIPortal objects from which the API(s) must be un-published. |
cancel, doesLoggedInUserHaveSufficientRolesOrPermissions, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects
java.util.Collection<APIPortal> getRegisteredApiPortals() throws CLLException
Collection
of APIPortal
objects which are registered with CentraSite.Collection
of APIPortal
objectsCLLException
- If an error occurs while retrieving the registered Portalsjava.util.Collection<APIPortal> getApplicableApiPortals() throws CLLException
Collection
of APIPortal
objects that are accessible by the current logged in user for unpublish.Collection
of APIPortal
objectsCLLException
void setSelectedApiPortals(java.util.Collection<APIPortal> selectedPortals) throws CLLException
Collection
of APIPortal
objects from which the API(s) must be un-published.selectedPortals
- The Collection
of APIPortal
objectsCLLException
- If an error occurs while trying to set the Portalsjava.lang.String getUnpublishReport() throws CLLException
CLLException
- If an error occurs while trying to get the unpublish statusjava.lang.String getUnublishResultString()
String
representation of the unpublish action