|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ControlInterface
public interface CampaignManagerControl
A custom Java Control used to manage campaigns.
Method Summary | |
---|---|
void |
cleanupAdBuckets(String campaignId) Cleans up a campaign's ad buckets |
void |
cleanupAdCounts(String campaignId) Cleans up a campaign's ad count. |
void |
cleanupEndStates(String campaignId) Clears all of the user end states associated to a campaign. |
void |
cleanupMailBatches(String campaignId) Cleans up a campaign's mail batches. |
CampaignModel |
getCampaign(String campaignUri, ResourceContext context) Returns a CampaignModel object representing the campaign at the specified URI. |
SortableFilterablePagedResult<CampaignModel> |
getCampaigns(int pageSize, ResourceContext context) Returns a PagedResult of all the CampaignModel objects within the system representing campaigns, in arbitrary order. |
ScenarioModel |
getScenario(CampaignModel campaignModel, String scenarioName, ResourceContext context) Returns a ScenarioModel object representing the scenario within the specified campaign, and with the specified name. |
RuleModel |
getScenarioRuleModel(ScenarioModel scenarioModel, String ruleModelName, ResourceContext context) Returns a RuleModel object representing the rule model within the specified scenario, and with the specified name. |
SortableFilterablePagedResult<RuleModel> |
getScenarioRuleModels(ScenarioModel scenarioModel, int pageSize, ResourceContext context) Returns a PagedResult of all the RuleModel objects contained within the specified scenario. |
SortableFilterablePagedResult<ScenarioModel> |
getScenarios(CampaignModel campaignModel, int pageSize, ResourceContext context) Returns a PagedResult of all the ScenarioModel objects within the specified campaign. |
void |
resetCampaign(String campaignId) Resets any cached state information on the specified campaign |
void |
setCampaign(CampaignModel model, ResourceContext context) Persists the given CampaignModel . |
void |
setCampaign(String campaignUri, CampaignModel model, boolean create, ResourceContext context) Persists the given CampaignModel . |
Method Detail |
---|
SortableFilterablePagedResult<CampaignModel> getCampaigns(int pageSize, ResourceContext context) throws com.bea.p13n.management.data.repository.PersistenceException, com.bea.p13n.entitlements.common.PolicyRefException, org.apache.xmlbeans.XmlException
PagedResult
of all the CampaignModel
objects within the system representing campaigns, in arbitrary order. Returns an empty list if no campaigns are defined.pageSize
- the int page size for the PagedResult
context
- the resource contextPagedResult
of CampaignModel
objectscom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for the model datacom.bea.p13n.entitlements.common.PolicyRefException
- if an error occurs while trying to check DA of the campaignsorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model dataPagedResult
, CampaignModel
CampaignModel getCampaign(String campaignUri, ResourceContext context) throws com.bea.p13n.management.data.repository.PersistenceException, org.apache.xmlbeans.XmlException
CampaignModel
object representing the campaign at the specified URI. Returns null if the campaign is not defined.campaignUri
- the string URI for the desired campaign.context
- the resource context.CampaignModel
representing the desired campaigncom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for the model dataorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model dataCampaignModel
SortableFilterablePagedResult<ScenarioModel> getScenarios(CampaignModel campaignModel, int pageSize, ResourceContext context) throws com.bea.p13n.management.data.repository.PersistenceException, com.bea.p13n.entitlements.common.PolicyRefException, org.apache.xmlbeans.XmlException
PagedResult
of all the ScenarioModel
objects within the specified campaign. Returns an empty list if no scenarios are defined.campaignModel
- the campaignModel containing containing the scenariospageSize
- the int page size for the PagedResult
context
- the resource contextPagedResult
of ScenarioModel
objectscom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for the model dataorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model datacom.bea.p13n.entitlements.common.PolicyRefException
ScenarioModel
ScenarioModel getScenario(CampaignModel campaignModel, String scenarioName, ResourceContext context) throws com.bea.p13n.management.data.repository.PersistenceException, org.apache.xmlbeans.XmlException
ScenarioModel
object representing the scenario within the specified campaign, and with the specified name. Returns null if the scenario is not defined.campaignModel
- the actual campaignModel containing the scenarioscenarioName
- the string name of the desired scenariocontext
- the resource contextScenarioModel
representing the desired scenariocom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for the model dataorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model dataCampaignModel
, ScenarioModel
SortableFilterablePagedResult<RuleModel> getScenarioRuleModels(ScenarioModel scenarioModel, int pageSize, ResourceContext context) throws com.bea.p13n.management.data.repository.PersistenceException, com.bea.p13n.entitlements.common.PolicyRefException, org.apache.xmlbeans.XmlException
PagedResult
of all the RuleModel
objects contained within the specified scenario. Returns an empty list if no rule models are defined.scenarioModel
- a scenarioModel for the scenario that contains the rule modelspageSize
- the int page size for the PagedResult
context
- the resource contextPagedResult
of RuleModel
objectscom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for the model dataorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model datacom.bea.p13n.entitlements.common.PolicyRefException
RuleModel
RuleModel getScenarioRuleModel(ScenarioModel scenarioModel, String ruleModelName, ResourceContext context) throws com.bea.p13n.management.data.repository.PersistenceException, com.bea.p13n.entitlements.common.PolicyRefException, org.apache.xmlbeans.XmlException
RuleModel
object representing the rule model within the specified scenario, and with the specified name. Returns null if the rule model is not defined.scenarioModel
- a scenarioModel for the scenario containing the rule modelruleModelName
- the string name of the desired rule modelcontext
- the resource contextRuleModel
representing the desired rulecom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for the model dataorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model datacom.bea.p13n.entitlements.common.PolicyRefException
ScenarioModel
, RuleModel
void setCampaign(CampaignModel model, ResourceContext context) throws IllegalArgumentException, com.bea.p13n.management.data.repository.MessageException, com.bea.p13n.management.data.repository.PersistenceException, org.apache.xmlbeans.XmlException
CampaignModel
. Any existing campaign at the given campaignUri will be replaced by the new one.model
- a CampaignModel
representing the campaigncontext
- the resource contextIllegalArgumentException
- if create=false and the campaign you are trying to replace does not exist at the given campaignUri.com.bea.p13n.management.data.repository.MessageException
- if an error occurs while persisting model datacom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for model data or persist model dataorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model datavoid setCampaign(String campaignUri, CampaignModel model, boolean create, ResourceContext context) throws IllegalArgumentException, com.bea.p13n.management.data.repository.MessageException, com.bea.p13n.management.data.repository.PersistenceException, org.apache.xmlbeans.XmlException
CampaignModel
. Any existing campaign at the given campaignUri will be replaced by the new one.campaignUri
- the string URI of the campaign. Cannot be null.model
- a CampaignModel
representing the campaigncreate
- if true then create the campaign if it does not exist. If false then do not create the campaign if it does not exist. In both cases, an existing campaign will be replaced with the new one.context
- the resource contextIllegalArgumentException
- if create=false and the campaign you are trying to replace does not exist at the given campaignUri.com.bea.p13n.management.data.repository.MessageException
- if an error occurs while persisting model datacom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for model data or persist model dataorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model datavoid resetCampaign(String campaignId) throws NamingException, RemoteException, javax.ejb.CreateException
campaignId
-NamingException
RemoteException
javax.ejb.CreateException
void cleanupEndStates(String campaignId) throws NamingException, RemoteException, javax.ejb.CreateException
campaignId
-NamingException
RemoteException
javax.ejb.CreateException
void cleanupAdBuckets(String campaignId) throws NamingException, RemoteException, javax.ejb.CreateException, ContentException
campaignId
-NamingException
RemoteException
javax.ejb.CreateException
ContentException
void cleanupAdCounts(String campaignId) throws NamingException, RemoteException, javax.ejb.CreateException, ContentException
campaignId
-NamingException
RemoteException
javax.ejb.CreateException
ContentException
void cleanupMailBatches(String campaignId) throws NamingException, RemoteException, javax.ejb.CreateException, MailServiceException
campaignId
-NamingException
RemoteException
javax.ejb.CreateException
MailServiceException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.