Constructor and Description |
---|
CampaignsServiceEndPoint() |
Modifier and Type | Method and Description |
---|---|
Campaign |
getCampaignDefinition(String campaignID)
Retrieves the campaign identified by the specified identifier
|
CampaignDetail |
getCampaignDetail(String campaignID)
Retrieves the
CampaignDetail associated with the campaign identified with the specified identifier |
PartialList<CampaignDetail> |
getCampaignDetails(Query query)
Retrieves campaign details for campaigns matching the specified query.
|
PartialList<CampaignEvent> |
getCampaignEvents(Query query)
Retrieves
CampaignEvent s matching the specified query. |
Set<Metadata> |
getCampaignMetadatas()
Retrieves the set of Metadata associated with existing campaigns.
|
Set<Metadata> |
getCampaignMetadatas(Query query)
Retrieves the set of Metadata associated with existing campaign matching the specified
Query |
void |
removeCampaignDefinition(String campaignID)
Removes the campaign associated with the specified identifier, also removing associated rules if needed.
|
void |
removeCampaignEventDefinition(String campaignEventID)
Removes the campaign event associated with the specified identifier.
|
void |
setCampaignDefinition(Campaign campaign)
Saves the specified campaign in the context server and creates associated
Rule s if the campaign is enabled. |
void |
setCampaignEventDefinition(CampaignEvent campaignEvent)
Saves the specified campaign event in the context server.
|
void |
setGoalsService(GoalsService goalsService) |
public void setGoalsService(GoalsService goalsService)
@GET @Path(value="/") public Set<Metadata> getCampaignMetadatas()
@POST @Path(value="/") public void setCampaignDefinition(Campaign campaign)
Rule
s if the campaign is enabled.campaign
- the Campaign to be saved@POST @Path(value="/query") public Set<Metadata> getCampaignMetadatas(Query query)
Query
query
- the Query used to filter the campagins which metadata we want to retrieveQuery
@POST @Path(value="/query/detailed") public PartialList<CampaignDetail> getCampaignDetails(Query query)
query
- the query specifying which campaigns to retrievePartialList
of campaign details for the campaigns matching the specified query@GET @Path(value="/{campaignID}/detailed") public CampaignDetail getCampaignDetail(@PathParam(value="campaignID") String campaignID)
CampaignDetail
associated with the campaign identified with the specified identifiercampaignID
- the identifier of the campaign for which we want to retrieve the detailsnull
if no such campaign exists@GET @Path(value="/{campaignID}") public Campaign getCampaignDefinition(@PathParam(value="campaignID") String campaignID)
campaignID
- the identifier of the campaign we want to retrievenull
if no such campaign exists@DELETE @Path(value="/{campaignID}") public void removeCampaignDefinition(@PathParam(value="campaignID") String campaignID)
campaignID
- the identifier of the campaign to be removed@POST @Path(value="/event") public void setCampaignEventDefinition(CampaignEvent campaignEvent)
campaignEvent
- the CampaignEvent to be saved@DELETE @Path(value="/event/{eventId}") public void removeCampaignEventDefinition(@PathParam(value="eventId") String campaignEventID)
campaignEventID
- the identifier of the campaign event to be removed@POST @Path(value="/events/query") public PartialList<CampaignEvent> getCampaignEvents(Query query)
CampaignEvent
s matching the specified query.query
- the Query specifying which CampaignEvents to retrievePartialList
of campaign events matching the specified queryCopyright © 2014–2022 Apache Software Foundation. All rights reserved.