public interface PublishToPortalAction extends CSOAction
Modifier and Type | Method and Description |
---|---|
java.util.Collection<APIPortal> |
getAlreadyPublishedApiPortals()
Returns the
Collection of APIPortal instances to which an API is
already published. |
java.util.Collection<APIPortal> |
getApplicableApiPortals()
Returns the
Collection of APIPortal objects that are accessible by the current logged in user for publish. |
java.util.Collection<Category> |
getEndpointSemantics()
Returns the
Collection of Category objects which indicate the endpoint semantics. |
java.lang.String |
getPublishReport()
This returns a JSON string which explains the publish status.
|
java.lang.String |
getPublishResultString()
Returns a string which sums up the result of publishing the selected APIs to the Portals.
|
java.util.Collection<APIPortal> |
getRegisteredApiPortals()
Returns the
Collection of APIPortal objects which are registered with CentraSite. |
void |
setSelectedApiPortals(java.util.Collection<APIPortal> selectedPortals)
Sets the
Collection of APIPortal objects to which the API(s) must be published. |
void |
setSelectedEndpointSemantics(java.util.Collection<Category> selectedEndpointSemantics)
Sets the
Collection of endpoint Category objects. |
cancel, doesLoggedInUserHaveSufficientRolesOrPermissions, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getNonApplicableReason, 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> getAlreadyPublishedApiPortals() throws CLLException
Collection
of APIPortal
instances to which an API is
already published. This applies only for single action and not for bulk action.Collection
of APIPortal
instancesCLLException
- If an error occurs while getting the list of already published
API-Portal instancesjava.util.Collection<APIPortal> getApplicableApiPortals() throws CLLException
Collection
of APIPortal
objects that are accessible by the current logged in user for publish.Collection
of APIPortal
objectsCLLException
void setSelectedApiPortals(java.util.Collection<APIPortal> selectedPortals) throws CLLException
Collection
of APIPortal
objects to which the API(s) must be published.selectedPortals
- The Collection
of APIPortal
objectsCLLException
- If an error occurs while trying to set the Portalsjava.util.Collection<Category> getEndpointSemantics() throws CLLException
Collection
of Category
objects which indicate the endpoint semantics.Collection
of Category
objectsCLLException
- If an error occurs while fetching the categoriesvoid setSelectedEndpointSemantics(java.util.Collection<Category> selectedEndpointSemantics) throws CLLException
Collection
of endpoint Category
objects. This indicates that only those endpoints
which are classified with the given set of categories from the selected API(s) will be published
to the selected Portal(s).selectedEndpointSemantics
- The Collection
of endpoint Category
objectsCLLException
- If an error occurs while trying to set the categoriesjava.lang.String getPublishReport() throws CLLException
CLLException
- If an error occurs while trying to get the publish statusjava.lang.String getPublishResultString()
String
representation of the publish result