|
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 SegmentManagerControl
A custom Java Control used to manage user segments.
Method Summary | |
---|---|
RuleModel |
getSegment(String segmentUri, ResourceContext context) Returns a RuleModel obect representing the user segment at the specified URI. |
SortableFilterablePagedResult<String> |
getSegmentNames(int pageSize, ResourceContext context) Returns a PagedResult of String s representing the names of all the user segments within the system, in arbitrary order. |
SortableFilterablePagedResult<RuleModel> |
getSegments(int pageSize, ResourceContext context) Returns a PagedResult of all the RuleModel objects within the system representing user segments, in arbitrary order. |
void |
setSegment(RuleModel model, ResourceContext context) Persists the given RuleModel representing a user segment. |
void |
setSegment(String segmentUri, RuleModel model, boolean create, ResourceContext context) Persists the given RuleModel representing a user segment. |
Method Detail |
---|
SortableFilterablePagedResult<RuleModel> getSegments(int pageSize, ResourceContext context) throws com.bea.p13n.management.data.repository.PersistenceException, org.apache.xmlbeans.XmlException
PagedResult
of all the RuleModel
objects within the system representing user segments, in arbitrary order. Returns an empty list if no user segments are defined.pageSize
- 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 dataPagedResult
, RuleModel
SortableFilterablePagedResult<String> getSegmentNames(int pageSize, ResourceContext context) throws com.bea.p13n.management.data.repository.PersistenceException, org.apache.xmlbeans.XmlException
PagedResult
of String
s representing the names of all the user segments within the system, in arbitrary order. Returns an empty list if no user segments are defined.pageSize
- 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 dataPagedResult
RuleModel getSegment(String segmentUri, ResourceContext context) throws com.bea.p13n.management.data.repository.PersistenceException, org.apache.xmlbeans.XmlException
RuleModel
obect representing the user segment at the specified URI. Returns null if the user segment is not defined.segmentUri
- the string URI for the desired user segmentcontext
- the resource contextRuleModel
representing the desired user segmentcom.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 dataRuleModel
void setSegment(RuleModel model, ResourceContext context) throws IllegalArgumentException, com.bea.p13n.management.data.repository.MessageException, com.bea.p13n.management.data.repository.PersistenceException, org.apache.xmlbeans.XmlException
RuleModel
representing a user segment. Any existing rule at the given segmentUri will be replaced by the new one.model
- a RuleModel
representing the user segmentcontext
- the resource contextIllegalArgumentException
- if create=false and the user segment you are trying to replace does not exist at the given segmentUri.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 setSegment(String segmentUri, RuleModel 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
RuleModel
representing a user segment. Any existing rule at the given segmentUri will be replaced by the new one.segmentUri
- segmentUri the string URI for the desired user segment. Cannot be null.model
- a RuleModel
representing the user segmentcreate
- if true then create the user segment if it does not exist. If false then do not create the user segment if it does not exist. In both cases, an existing user segment will be replaced with the new one.context
- the resource contextIllegalArgumentException
- if create=false and the user segment you are trying to replace does not exist at the given segmentUri.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 data
|
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.